--- mitgcm.org/front_content/using_cvs.xml	2003/12/04 02:14:52	1.1
+++ mitgcm.org/front_content/using_cvs.xml	2011/05/11 17:45:01	1.14
@@ -14,7 +14,6 @@
     <meta name="add_title" content="Using CVS" />
     <!-- Hinting for menu generation -->
 
-    <title>MITgcm: <!--ADDTITLE--></title>
 <style type="text/css">
  span.c2 {font-size: 110%}
  div.c1 {text-align: center}
@@ -33,26 +32,41 @@
       to use the CVS "pserver" mechanism.  This method only allows you to "check
       out" (or obtain a local copy) of the source.  It does not provide a
       mechanism for "committing" or "checking in" changes (please see below).
-      Using CVS pserver from the command line requires just a three
-      commands:</p>
-    
-<blockquote>
-Using a Bourne, "bash", or "sh-compatible" shell:
+      Using CVS pserver from the command line requires just a three commands.
+      Using a Bourne, "bash", or "sh-compatible" shell they are:</p>
+
+<pre>
+  $ export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'
+  $ cvs login
+    ( enter the CVS password: "cvsanon" )
+  $ cvs co -P MITgcm
+</pre>
+
+    <p>Using a "C", "csh", or "tcsh" shell the commands are:</p>
+
+<pre>
+  $ setenv CVSROOT ':pserver:cvsanon@mitgcm.org:/u/gcmpack'
+  $ cvs login
+    ( enter the CVS password: "cvsanon" )
+  $ cvs co -P MITgcm
+</pre>
+
+    <p>using the "-P" option to check-out ("<i>cvs co -P</i>") prevents
+    to download unnecessary empty directories.</p>
+
+    <p>A large amount of additional (optional!) content is available
+    from the <i>MITgcm_contrib</i> directory; much of it is specific to certain
+    setups (eg. high-res setups, in-development material that is not yet part
+    of the "main" code, etc ...).
+    But rather than checking out the full content of MITgcm_contrib
+    ("<i>cvs co -P MITgcm_contrib</i>"), which takes a long time to download
+    (particularly from remote locations), we recommend to download only the
+    specific part of interest, e.g.: "<i>submesoscale</i>" directory,
+    which can be checked out using:</p>
+
 <pre>
-$  export CVSROOT=':pserver:cvsanon@mitgcm.org:/usr/local/gcmpack'
-$  cvs login 
-( enter the CVS password: "cvsanon" )
-$  cvs co MITgcm MITgcm_contrib
-</pre><br />
-
-Using a "C", "csh", or "tcsh" shell:
-<pre>
-$  setenv CVSROOT ':pserver:cvsanon@mitgcm.org:/usr/local/gcmpack'
-$  cvs login
-( enter the CVS password: "cvsanon" )
-$  cvs co MITgcm MITgcm_contrib
+  $ cvs co -P MITgcm_contrib/submesoscale
 </pre>
-</blockquote>
 
     <p>Note that you will only need to perform the "cvs login" once.  And for
       convenience, you may want to add the CVSROOT variable to your shell's
@@ -63,12 +77,12 @@
     <h4>Getting Parts of the Source "Tree"</h4>
 
     <p>The above commands demonstrate how to check out all of the MITgcm code
-      and the "contributed" (that is, unsupported by often useful) information
-      within the "MITgcm_contrib" directory.  In many cases, this is overkill
-      and can result in long download times.  To reduce the volume of
-      information downloaded and thereby speedup the download times, one can
-      select one of the following pre-defined "aliases" that will provide a
-      sub-set of the entire MITgcm source "tree":</p>
+      and the "contributed" (that is, unsupported but occasionally useful)
+      information within the "<i>MITgcm_contrib</i>" directory. In many cases,
+      this is overkill and can result in long download times.
+      To reduce the volume of information downloaded and thereby speedup the
+      download times, one can select one of the following pre-defined "aliases"
+      that will provide a sub-set of the entire MITgcm source "tree":</p>
 
     <table align="center" border="0" cellpadding="10" width="90%" summary="CVS
       aliases">
@@ -82,10 +96,20 @@
       </tr>
       <tr bgcolor="#bbddff">
  	<td width="25%">MITgcm_verif_basic</td>
-	<td>Source code plus three of the verification examples
-	  ("adjustment.128x64x1", "internal_wave", and
-	  "solid-body.cs-32x32x1").</td>
-     </tr>
+	<td>Source code plus a small set of the verification examples
+	  ("aim.5l_cs", "hs94.128x64x5", "ideal_2D_oce", "lab_sea",
+	   "tutorial_baroclinic_gyre", "tutorial_global_oce_latlon"
+           and "tutorial_plume_on_slope").</td>
+      </tr>
+      <tr bgcolor="#bbffdd">
+	<td width="25%">MITgcm_tutorials</td>
+	<td>Source code plus all of the tutorials examples.</td>
+      </tr>
+      <tr bgcolor="#bbddff">
+	<td width="25%">MITgcm_verif_all</td>
+	<td>Source code plus all of the verification examples.</td>
+      </tr>
+      <!--
       <tr bgcolor="#bbffdd">
 	<td width="25%">MITgcm_verif_atmos</td>
 	<td>Source code plus all of the atmospheric examples.</td>
@@ -94,11 +118,6 @@
  	<td width="25%">MITgcm_verif_ocean</td>
 	<td>Source code plus all of the oceanic examples.</td>
      </tr>
-      <tr bgcolor="#bbffdd">
-	<td width="25%">MITgcm_verif_all</td>
-	<td>Source code plus all of the verification examples.</td>
-      </tr>
-      <!--
       <tr bgcolor="#bbddff">
  	<td width="25%"></td>
 	<td></td>
@@ -110,25 +129,32 @@
       -->
     </table>
 
+    <p>It is important to note that the CVS aliases above cannot be used in
+      conjunction with the CVS <i>-d DIRNAME</i> option.  However, the MITgcm
+      directories they create can be changed to a different name following the
+      check-out:</p>
+<pre>
+  $ cvs co -P MITgcm_verif_basic
+  $ mv MITgcm MITgcm_verif_basic
+</pre>
 
     <h4>Getting Specific Releases or "Checkpoints"</h4>
     
-    <p>As shown within the <a
-      href="http://dev.mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/doc/tag-index"> CVS
-      Code Browser</a>, the MITgcm code is continuously undergoing updates.  At
+    <p>As shown within the 
+      <!-- <a href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/doc/tag-index">CVS Code Browser</a> -->
+      <a href="http://mitgcm.org/viewvc/MITgcm/MITgcm/doc/tag-index">CVS Code Browser</a>
+      , the MITgcm code is continuously undergoing updates.  At
       points during the development (typically, after work has been done and the
-      source code has passed the <a href="testing/latest.html">verification
+      source code has passed the <a href="./testing.html">verification
       tests</a>), a release or checkpoint "tag" is created.  These tags are a
       convenient mechanism for referring to different times or points within the
       development.  One can check out these versions using the "-r TAG_NAME" CVS
       option such as: </p>
 
-<blockquote>
 <pre>
-$  cvs co -r release1_p5 MITgcm
-$  cvs co -r checkpoint52a_post MITgcm
+  $ cvs co -P -r release1_p5 MITgcm
+  $ cvs co -P -r checkpoint52a_post MITgcm
 </pre>
-</blockquote>
 
     <p>By default (that is, when no tag is specified), CVS will retrieve the
       latest version of all files.</p>
@@ -140,27 +166,29 @@
       that you yourself have made since obtaining the code.  From within
       your working directory:</p>
 
-<blockquote>
-<pre>cvs diff</pre>
-</blockquote>
+<pre>
+  cvs diff
+</pre>
+
 
     <p>will show the differences between your version and the version that you
       checked out. It acts recursively on all directories below your current
       directory. You can limit the operation to just one file or directory by
       specifying those as arguments:</p>
 
-<blockquote>
-<pre>cvs diff <i>file</i></pre>
-</blockquote>
+<pre>
+  cvs diff <i>file</i>
+</pre>
+
 
     <h4>Show changes to the repository that you don't have</h4>
 
     <p>The source code evolves continuously and you should try to stay up to
       date.  To see what needs to be updated:</p>
 
-<blockquote>
-<pre>cvs -n update</pre>
-</blockquote>
+<pre>
+  cvs -n update
+</pre>
 
     <p>behaves just as "cvs update" but doesn't actually change anything. This
       is a useful way of summarizing the state of your code. The meaning of the
@@ -171,31 +199,31 @@
     <p>You can download and merge updates from the repository to bring you
       working code up to date:</p>
 
-<blockquote>
-<pre>cvs update -d -P</pre>
-</blockquote>
+<pre>
+  cvs update -d -P
+</pre>
 
       <p>will work recursively on all files in the current directory and below.
 	To update just a specific file or directory:</p>
 
-<blockquote>
-<pre>cvs update <i>file</i></pre>
-</blockquote>
+<pre>
+  cvs update <i>file</i>
+</pre>
 
     <p>You can also update to a specific version, just as you could check out
       a specific version.</p>
 
-<blockquote>
-<pre>cvs update -d -P -r release1_p5</pre>
-</blockquote>
+<pre>
+  cvs update -d -P -r release1_p5
+</pre>
 
     <p>If you checked out a specific version and want to update to the very
       latest use the -A option will remove associated with a specific version as
       follows:</p>
 
-<blockquote>
-<pre>cvs update -d -P -A</pre>
-</blockquote>
+<pre>
+  cvs update -d -P -A
+</pre>
 
     <p>"cvs update" produces output to the terminal with the following
       meanings:</p>
@@ -242,14 +270,11 @@
 
     <h4>Wow! CVS is so good, where can I learn more?</h4>
 
-    <p>The <a href="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">basic
-      manual</a> is a good reference. There is also an <a
-      href="http://web.mit.edu/afs/athena.mit.edu/project/gnu/doc/html/cvs_toc.html">online
-      tutorial</a> as well as an <a
-      href="http://www.loria.fr/~molli/cvs/cvstrain/cvstrain.html">training
-      manual</a>. For those who prefer the good old fashioned book there's <a
-      href="http://cvsbook.red-bean.com/">"Open Source Development With
-      CVS"</a>.</p>
+    <p>The <a 
+      href="http://web.mit.edu/afs/athena.mit.edu/project/gnu/doc/html/cvs_toc.html">basic 
+      manual</a> is a good reference.
+      For those who prefer the good old fashioned book there's
+      <a href="http://cvsbook.red-bean.com/">"Open Source Development With CVS"</a>.</p>
 
   </body>
 </html>