/[MITgcm]/mitgcm.org/front_content/using_cvs.xml

Diff of /mitgcm.org/front_content/using_cvs.xml

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.13 by jmc,
Fri Jan 22 01:03:02 2010 UTC
+revision 1.17 by dimitri,
Sat Nov 21 16:59:15 2015 UTC
 Line 21
    </head>
    <body>
      <center>
        <h3>Obtaining the MITgcm Source using CVS</h3>
      </center>
 Line 34
        mechanism for "committing" or "checking in" changes (please see below).
        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 MITgcm
+   $ cvs co -P MITgcm
  </pre>
      <p>Using a "C", "csh", or "tcsh" shell the commands are:</p>
 Line 48
    $ setenv CVSROOT ':pserver:cvsanon@mitgcm.org:/u/gcmpack'
    $ cvs login
      ( enter the CVS password: "cvsanon" )
-   $ cvs co MITgcm
+   $ cvs co -P MITgcm
  </pre>
-     <p>A large amount of additional (optional!) content can be obtained from the
+     <p>using the "-P" option to check-out ("<i>cvs co -P</i>") prevents
-       MITgcm_contrib directory that can be checked out using:
+     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>
-   $ cvs co MITgcm_contrib
+   $ cvs co -P MITgcm_contrib/submesoscale
  </pre>
-       In general, we do not recommend checking out all of MITgcm_contrib since
-       it takes a long time to download (particularly from remote locations) and
-       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.).</p>
      <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
        environment (that is, define it within your "~/.bashrc" or "~/.chsrc"
        files).</p>
+     <p>Also note that it is possible to checkout code without "cvs login" and
+       without setting any shell environment variables by specifying the
+       pserver name and password in one line, for example:</p>
+ <pre>
+   $ cvs -d :pserver:cvsanon:cvsanon@mitgcm.org:/u/gcmpack co -P MITgcm
+ </pre>
      <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 occasionally useful)
+       and the "contributed" (that is, unsupported but occasionally useful)
-       information within the "MITgcm_contrib" directory.  In many cases, this is
+       information within the "<i>MITgcm_contrib</i>" directory. In many cases,
-       overkill and can result in long download times.  To reduce the volume of
+       this is overkill and can result in long download times.
-       information downloaded and thereby speedup the download times, one can
+       To reduce the volume of information downloaded and thereby speedup the
-       select one of the following pre-defined "aliases" that will provide a
+       download times, one can select one of the following pre-defined "aliases"
-       sub-set of the entire MITgcm source "tree":</p>
+       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">
-Line 130
+Line 141
        directories they create can be changed to a different name following the
        check-out:</p>
  <pre>
-   $ cvs co MITgcm_verif_basic
+   $ 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://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
-Line 148
+Line 159
        option such as: </p>
  <pre>
-   $ cvs co -r release1_p5 MITgcm
+   $ cvs co -P -r release1_p5 MITgcm
-   $ cvs co -r checkpoint52a_post MITgcm
+   $ cvs co -P -r checkpoint52a_post MITgcm
  </pre>
      <p>By default (that is, when no tag is specified), CVS will retrieve the
-       latest version of all files.</p>
+       latest version of all files. To download an older version corresponding
+       to a specific time, e.g., May 1rst, 2008, at 5pm, one can use the "-D"
+       CVS option as follows: </p>
+ <pre>
+   $ cvs co -P -D "2008-05-01 17:00" MITgcm
+ </pre>
      <h4>Show changes that YOU have made</h4>
-Line 223
+Line 239
      <p>"cvs update" produces output to the terminal with the following
        meanings:</p>
      <table align="center" border="0" cellpadding="10" width="90%" summary="CVS
        update codes">
        <tr bgcolor="#00cccc">
-Line 266
+Line 282
      <h4>Wow! CVS is so good, where can I learn more?</h4>
      <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>

 Legend:



Removed from v.1.13
 


changed lines


 
Added in v.1.17
 Legend:



Removed from v.1.13
 


changed lines


 
Added in v.1.17
-Removed from v.1.13
+Added in v.1.17

	ViewVC Help
Powered by ViewVC 1.1.22