]> git.mjollnir.org Git - moodle.git/commitdiff
First quick version of help on CVS
authormoodler <moodler>
Thu, 28 Nov 2002 03:05:24 +0000 (03:05 +0000)
committermoodler <moodler>
Thu, 28 Nov 2002 03:05:24 +0000 (03:05 +0000)
doc/cvs.html [new file with mode: 0755]

diff --git a/doc/cvs.html b/doc/cvs.html
new file mode 100755 (executable)
index 0000000..0c91aef
--- /dev/null
@@ -0,0 +1,87 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\r
+<HTML>\r
+<HEAD>\r
+  <TITLE>Moodle Docs: How to use CVS</TITLE>\r
+  <LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">\r
+</HEAD>\r
+<BODY BGCOLOR="#ffffff">\r
+  \r
+<H2>How to use CVS</H2>\r
+<BLOCKQUOTE>\r
+<P>CVS is the Concurrent Versioning System.  It's a commonly used way \r
+of storing source code because it keeps versions of all files so \r
+that nothing is ever lost, and usage by different people is tracked.</P>\r
+\r
+<P>To use Moodle's CVS archive (as a developer) from a Unix machine, you first \r
+  need to have an account on <a href="http://www.sf.net/">Sourceforge</a>. For \r
+  the example, let's assume your username is <strong>myusername</strong> and your \r
+  password is <strong>mypassword</strong>. Secondly, you need to contact &lt;A \r
+  HREF=&quot;http://dougiamas.com/&quot;&gt;Martin&lt;/A&gt; to get write access \r
+  to particular directories.</P>\r
+<P>With that done, you should have all the permissions you need, so you just need \r
+  to set up your machine and download the current sources so you can start working \r
+  on them.</P>\r
+<P>Sourceforge CVS uses ssh as a transport layer for security, so you will have \r
+  to set this CVS_RSH environment variable in your Unix shell:</P>\r
+<blockquote>\r
+  <pre><strong>setenv CVS_RSH ssh</strong> (for csh, tcsh etc)</pre>\r
+  \r
+  <pre><strong>export CVS_RSH=ssh</strong> (for sh, bash etc)</pre>\r
+\r
+</blockquote>\r
+<p>It's best to put this in your .bashrc or .cshrc so you don't have to type it \r
+  all the time. Then, check out Moodle using this (all one line): </p>\r
+<blockquote>\r
+  <pre><strong>cvs -z3 -d:ext:myusername@cvs.moodle.sourceforge.net:/cvsroot/moodle co moodle</strong></pre>\r
+\r
+</blockquote>\r
+<p>Don't try to do run this first CVS command into an existing moodle directory \r
+  - start fresh with a new directory.</p>\r
+<p>Note that you will be prompted for <strong>mypassword</strong> with each CVS \r
+  command. To avoid this, follow the <a href="http://sourceforge.net/account/editsshkeys.php">Sourceforge \r
+  directions about using authorized keys</a>.</p>\r
+<p>Now, you should have a new 'moodle' directory. You can rename it and move it \r
+  around if you like. Go into it: </p>\r
+<blockquote>\r
+  <pre><strong>cd moodle </strong></pre>\r
+\r
+</blockquote>\r
+<p>All the latest Moodle files should be in there. You can now change files in \r
+  your copy. To compare your files against the main CVS copy on the server use \r
+  cvs diff, eg: </p>\r
+<blockquote>\r
+  <pre><strong>cvs diff -c config-dist.php\r
+cvs diff -c lang</strong></pre>\r
+\r
+</blockquote>\r
+<p>To fetch the latest updates from the server use: </p>\r
+<blockquote>\r
+  <pre><strong>cvs update -dP</strong> </pre>\r
+\r
+</blockquote>\r
+<p>To copy your new files back to the server you would do: </p>\r
+<blockquote>\r
+  <pre><strong>cd lang/ca \r
+cvs commit</strong> </pre>\r
+\r
+</blockquote>\r
+<p>You will be prompted to add some comments (depends on your default text editor) \r
+  ... add a comment and close the editor ... the files will be sent to Sourceforge \r
+  and stored. Done! </p>\r
+<p>To save more time you can put default arguments into a file called .cvsrc in \r
+  your home directory. For example, mine contains: </p>\r
+<blockquote>\r
+  <pre><strong>diff -c \r
+update -dP</strong> </pre>\r
+\r
+</blockquote>\r
+<p>Try 'cvs help' for more details ... </p>\r
+<P>&nbsp;</P>\r
+\r
+</BLOCKQUOTE>\r
+<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="." TARGET="_top">Moodle Documentation</A></FONT></P>\r
+<P ALIGN="CENTER"><FONT SIZE="1">Version: $Id: features.html,v 1.2 2001/12/09 \r
+  10:34:19 martin Exp $</FONT></P>\r
+\r
+</BODY>\r
+</HTML>\r