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

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

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


Revision 1.15 - (hide annotations) (download) (as text)
Thu Jul 5 22:30:36 2012 UTC (11 years, 10 months ago) by jmc
Branch: MAIN
Changes since 1.14: +12 -7 lines
File MIME type: text/xml
add an example for "cvs co -D DATE"

1 edhill 1.1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3    
4     <html xmlns="http://www.w3.org/1999/xhtml">
5     <head>
6     <meta name="generator" content="HTML Tidy, see www.w3.org" />
7     <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
8     <base href="http:/mitgcm.org" />
9    
10     <!-- Hinting for menu generation -->
11     <meta name="add_name_0" content="Source Code" />
12     <meta name="add_name_1" content="Using CVS" />
13     <meta name="add_name_2" content="" />
14     <meta name="add_title" content="Using CVS" />
15     <!-- Hinting for menu generation -->
16    
17     <style type="text/css">
18     span.c2 {font-size: 110%}
19     div.c1 {text-align: center}
20     </style>
21     </head>
22    
23     <body>
24 jmc 1.15
25 edhill 1.1 <center>
26     <h3>Obtaining the MITgcm Source using CVS</h3>
27     </center>
28    
29     <h4>Using CVS "pserver" for Anonymous Access</h4>
30    
31     <p>The most convenient way to get local copies of the MITgcm source code is
32     to use the CVS "pserver" mechanism. This method only allows you to "check
33     out" (or obtain a local copy) of the source. It does not provide a
34     mechanism for "committing" or "checking in" changes (please see below).
35 edhill 1.3 Using CVS pserver from the command line requires just a three commands.
36     Using a Bourne, "bash", or "sh-compatible" shell they are:</p>
37 jmc 1.14
38 edhill 1.1 <pre>
39 edhill 1.3 $ export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'
40 jmc 1.14 $ cvs login
41 edhill 1.3 ( enter the CVS password: "cvsanon" )
42 jmc 1.14 $ cvs co -P MITgcm
43 edhill 1.3 </pre>
44    
45     <p>Using a "C", "csh", or "tcsh" shell the commands are:</p>
46    
47     <pre>
48     $ setenv CVSROOT ':pserver:cvsanon@mitgcm.org:/u/gcmpack'
49     $ cvs login
50     ( enter the CVS password: "cvsanon" )
51 jmc 1.14 $ cvs co -P MITgcm
52 edhill 1.9 </pre>
53    
54 jmc 1.14 <p>using the "-P" option to check-out ("<i>cvs co -P</i>") prevents
55     to download unnecessary empty directories.</p>
56    
57     <p>A large amount of additional (optional!) content is available
58     from the <i>MITgcm_contrib</i> directory; much of it is specific to certain
59     setups (eg. high-res setups, in-development material that is not yet part
60     of the "main" code, etc ...).
61     But rather than checking out the full content of MITgcm_contrib
62     ("<i>cvs co -P MITgcm_contrib</i>"), which takes a long time to download
63     (particularly from remote locations), we recommend to download only the
64     specific part of interest, e.g.: "<i>submesoscale</i>" directory,
65     which can be checked out using:</p>
66 edhill 1.9
67     <pre>
68 jmc 1.14 $ cvs co -P MITgcm_contrib/submesoscale
69 edhill 1.9 </pre>
70    
71 edhill 1.1 <p>Note that you will only need to perform the "cvs login" once. And for
72     convenience, you may want to add the CVSROOT variable to your shell's
73     environment (that is, define it within your "~/.bashrc" or "~/.chsrc"
74     files).</p>
75    
76    
77     <h4>Getting Parts of the Source "Tree"</h4>
78    
79     <p>The above commands demonstrate how to check out all of the MITgcm code
80 jmc 1.14 and the "contributed" (that is, unsupported but occasionally useful)
81     information within the "<i>MITgcm_contrib</i>" directory. In many cases,
82     this is overkill and can result in long download times.
83     To reduce the volume of information downloaded and thereby speedup the
84     download times, one can select one of the following pre-defined "aliases"
85     that will provide a sub-set of the entire MITgcm source "tree":</p>
86 edhill 1.1
87     <table align="center" border="0" cellpadding="10" width="90%" summary="CVS
88     aliases">
89     <tr bgcolor="#00cccc">
90     <td width="25%">Alias Name</td>
91     <td>Information (directories) Contained</td>
92     </tr>
93     <tr bgcolor="#bbffdd">
94     <td width="25%">MITgcm_code</td>
95     <td>Only the source code -- none of the verification examples.</td>
96     </tr>
97     <tr bgcolor="#bbddff">
98     <td width="25%">MITgcm_verif_basic</td>
99 edhill 1.2 <td>Source code plus a small set of the verification examples
100 jmc 1.11 ("aim.5l_cs", "hs94.128x64x5", "ideal_2D_oce", "lab_sea",
101     "tutorial_baroclinic_gyre", "tutorial_global_oce_latlon"
102     and "tutorial_plume_on_slope").</td>
103     </tr>
104     <tr bgcolor="#bbffdd">
105     <td width="25%">MITgcm_tutorials</td>
106     <td>Source code plus all of the tutorials examples.</td>
107     </tr>
108     <tr bgcolor="#bbddff">
109     <td width="25%">MITgcm_verif_all</td>
110     <td>Source code plus all of the verification examples.</td>
111     </tr>
112     <!--
113 edhill 1.1 <tr bgcolor="#bbffdd">
114     <td width="25%">MITgcm_verif_atmos</td>
115     <td>Source code plus all of the atmospheric examples.</td>
116     </tr>
117     <tr bgcolor="#bbddff">
118     <td width="25%">MITgcm_verif_ocean</td>
119     <td>Source code plus all of the oceanic examples.</td>
120     </tr>
121     <tr bgcolor="#bbddff">
122     <td width="25%"></td>
123     <td></td>
124     </tr>
125     <tr bgcolor="#bbffdd">
126     <td width="25%"></td>
127     <td></td>
128     </tr>
129     -->
130     </table>
131    
132 edhill 1.6 <p>It is important to note that the CVS aliases above cannot be used in
133 edhill 1.7 conjunction with the CVS <i>-d DIRNAME</i> option. However, the MITgcm
134 edhill 1.6 directories they create can be changed to a different name following the
135     check-out:</p>
136     <pre>
137 jmc 1.14 $ cvs co -P MITgcm_verif_basic
138 edhill 1.6 $ mv MITgcm MITgcm_verif_basic
139     </pre>
140 edhill 1.1
141     <h4>Getting Specific Releases or "Checkpoints"</h4>
142 jmc 1.15
143     <p>As shown within the
144 jmc 1.12 <!-- <a href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/doc/tag-index">CVS Code Browser</a> -->
145     <a href="http://mitgcm.org/viewvc/MITgcm/MITgcm/doc/tag-index">CVS Code Browser</a>
146     , the MITgcm code is continuously undergoing updates. At
147 edhill 1.1 points during the development (typically, after work has been done and the
148 jmc 1.12 source code has passed the <a href="./testing.html">verification
149 edhill 1.1 tests</a>), a release or checkpoint "tag" is created. These tags are a
150     convenient mechanism for referring to different times or points within the
151     development. One can check out these versions using the "-r TAG_NAME" CVS
152     option such as: </p>
153    
154     <pre>
155 jmc 1.14 $ cvs co -P -r release1_p5 MITgcm
156     $ cvs co -P -r checkpoint52a_post MITgcm
157 edhill 1.1 </pre>
158    
159     <p>By default (that is, when no tag is specified), CVS will retrieve the
160 jmc 1.15 latest version of all files. To download an older version corresponding
161     to a specific time, e.g., May 1rst, 2008, at 5pm, one can use the "-D"
162     CVS option as follows: </p>
163 edhill 1.1
164 jmc 1.15 <pre>
165     $ cvs co -P -D "2008-05-01 17:00" MITgcm
166     </pre>
167 edhill 1.1
168     <h4>Show changes that YOU have made</h4>
169    
170     <p>If you are running into difficulties it is very useful to see the changes
171     that you yourself have made since obtaining the code. From within
172     your working directory:</p>
173    
174 edhill 1.3 <pre>
175     cvs diff
176     </pre>
177    
178 edhill 1.1
179     <p>will show the differences between your version and the version that you
180     checked out. It acts recursively on all directories below your current
181     directory. You can limit the operation to just one file or directory by
182     specifying those as arguments:</p>
183    
184 edhill 1.3 <pre>
185     cvs diff <i>file</i>
186     </pre>
187    
188 edhill 1.1
189     <h4>Show changes to the repository that you don't have</h4>
190    
191     <p>The source code evolves continuously and you should try to stay up to
192     date. To see what needs to be updated:</p>
193    
194 edhill 1.3 <pre>
195     cvs -n update
196     </pre>
197 edhill 1.1
198     <p>behaves just as "cvs update" but doesn't actually change anything. This
199     is a useful way of summarizing the state of your code. The meaning of the
200     output is summarized in the next topic.</p>
201    
202     <h4>Getting updates from the repository</h4>
203    
204     <p>You can download and merge updates from the repository to bring you
205     working code up to date:</p>
206    
207 edhill 1.3 <pre>
208     cvs update -d -P
209     </pre>
210 edhill 1.1
211     <p>will work recursively on all files in the current directory and below.
212     To update just a specific file or directory:</p>
213    
214 edhill 1.3 <pre>
215     cvs update <i>file</i>
216     </pre>
217 edhill 1.1
218     <p>You can also update to a specific version, just as you could check out
219     a specific version.</p>
220    
221 edhill 1.3 <pre>
222     cvs update -d -P -r release1_p5
223     </pre>
224 edhill 1.1
225     <p>If you checked out a specific version and want to update to the very
226     latest use the -A option will remove associated with a specific version as
227     follows:</p>
228    
229 edhill 1.3 <pre>
230     cvs update -d -P -A
231     </pre>
232 edhill 1.1
233     <p>"cvs update" produces output to the terminal with the following
234     meanings:</p>
235 jmc 1.15
236 edhill 1.1 <table align="center" border="0" cellpadding="10" width="90%" summary="CVS
237     update codes">
238     <tr bgcolor="#00cccc">
239     <td width="20%">Return Code</td>
240     <td>Description</td>
241     </tr>
242     <tr bgcolor="#bbffdd">
243     <td width="20%">U <i>file</i></td>
244     <td>indicates that <i>file</i> was brought up to date with the
245     repository or that it exists in the repository but not in your work
246     space</td>
247     </tr>
248     <tr bgcolor="#bbddff">
249     <td width="20%">P <i>file</td>
250     <td>does exactly as above but uses the "patch" method</td>
251     </tr>
252     <tr bgcolor="#bbffdd">
253     <td width="20%">M <i>file</i></td>
254     <td>means the <i>file</i> was modified in your work space. Any
255     additional changes from the repository were merged in
256     successfully</td>
257     </tr>
258     </tr>
259     <tr bgcolor="#bbddff">
260     <td width="20%">C <i>file</i></td>
261     <td>means a merge is necessary because both the your copy and the
262     repository have changed <b>but</b> there is a conflict between the
263     changes</td>
264     </tr>
265     <tr bgcolor="#bbffdd">
266     <td width="20%">? <i>file</i></td>
267     <td>means the file exists in your work space but not on the
268     repository</td>
269     </tr>
270     </table>
271    
272     <p>When conflicts arise, the sections of code are both kept and surrounded
273     by &lt;&lt;&lt;&lt;&lt;, ===== and >>>>> indicators. You need to examine
274     these lines of the files and resolve the conflict.</p>
275    
276     <h4>Wow! CVS is so good, where can I learn more?</h4>
277    
278 jmc 1.15 <p>The <a
279     href="http://web.mit.edu/afs/athena.mit.edu/project/gnu/doc/html/cvs_toc.html">basic
280 jmc 1.13 manual</a> is a good reference.
281     For those who prefer the good old fashioned book there's
282     <a href="http://cvsbook.red-bean.com/">"Open Source Development With CVS"</a>.</p>
283 edhill 1.1
284     </body>
285     </html>
286    

  ViewVC Help
Powered by ViewVC 1.1.22