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

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

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


Revision 1.17 - (show annotations) (download) (as text)
Sat Nov 21 16:59:15 2015 UTC (5 years, 8 months ago) by dimitri
Branch: MAIN
CVS Tags: HEAD
Changes since 1.16: +7 -9 lines
File MIME type: text/xml
Moving 1-line CVS command to a more logical location --- until we GitHooked.

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
25 <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 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
38 <pre>
39 $ export CVSROOT=':pserver:cvsanon@mitgcm.org:/u/gcmpack'
40 $ cvs login
41 ( enter the CVS password: "cvsanon" )
42 $ cvs co -P MITgcm
43 </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 $ cvs co -P MITgcm
52 </pre>
53
54 <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
67 <pre>
68 $ cvs co -P MITgcm_contrib/submesoscale
69 </pre>
70
71 <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 <p>Also note that it is possible to checkout code without "cvs login" and
77 without setting any shell environment variables by specifying the
78 pserver name and password in one line, for example:</p>
79
80 <pre>
81 $ cvs -d :pserver:cvsanon:cvsanon@mitgcm.org:/u/gcmpack co -P MITgcm
82 </pre>
83
84 <h4>Getting Parts of the Source "Tree"</h4>
85
86 <p>The above commands demonstrate how to check out all of the MITgcm code
87 and the "contributed" (that is, unsupported but occasionally useful)
88 information within the "<i>MITgcm_contrib</i>" directory. In many cases,
89 this is overkill and can result in long download times.
90 To reduce the volume of information downloaded and thereby speedup the
91 download times, one can select one of the following pre-defined "aliases"
92 that will provide a sub-set of the entire MITgcm source "tree":</p>
93
94 <table align="center" border="0" cellpadding="10" width="90%" summary="CVS
95 aliases">
96 <tr bgcolor="#00cccc">
97 <td width="25%">Alias Name</td>
98 <td>Information (directories) Contained</td>
99 </tr>
100 <tr bgcolor="#bbffdd">
101 <td width="25%">MITgcm_code</td>
102 <td>Only the source code -- none of the verification examples.</td>
103 </tr>
104 <tr bgcolor="#bbddff">
105 <td width="25%">MITgcm_verif_basic</td>
106 <td>Source code plus a small set of the verification examples
107 ("aim.5l_cs", "hs94.128x64x5", "ideal_2D_oce", "lab_sea",
108 "tutorial_baroclinic_gyre", "tutorial_global_oce_latlon"
109 and "tutorial_plume_on_slope").</td>
110 </tr>
111 <tr bgcolor="#bbffdd">
112 <td width="25%">MITgcm_tutorials</td>
113 <td>Source code plus all of the tutorials examples.</td>
114 </tr>
115 <tr bgcolor="#bbddff">
116 <td width="25%">MITgcm_verif_all</td>
117 <td>Source code plus all of the verification examples.</td>
118 </tr>
119 <!--
120 <tr bgcolor="#bbffdd">
121 <td width="25%">MITgcm_verif_atmos</td>
122 <td>Source code plus all of the atmospheric examples.</td>
123 </tr>
124 <tr bgcolor="#bbddff">
125 <td width="25%">MITgcm_verif_ocean</td>
126 <td>Source code plus all of the oceanic examples.</td>
127 </tr>
128 <tr bgcolor="#bbddff">
129 <td width="25%"></td>
130 <td></td>
131 </tr>
132 <tr bgcolor="#bbffdd">
133 <td width="25%"></td>
134 <td></td>
135 </tr>
136 -->
137 </table>
138
139 <p>It is important to note that the CVS aliases above cannot be used in
140 conjunction with the CVS <i>-d DIRNAME</i> option. However, the MITgcm
141 directories they create can be changed to a different name following the
142 check-out:</p>
143 <pre>
144 $ cvs co -P MITgcm_verif_basic
145 $ mv MITgcm MITgcm_verif_basic
146 </pre>
147
148 <h4>Getting Specific Releases or "Checkpoints"</h4>
149
150 <p>As shown within the
151 <!-- <a href="http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm/doc/tag-index">CVS Code Browser</a> -->
152 <a href="http://mitgcm.org/viewvc/MITgcm/MITgcm/doc/tag-index">CVS Code Browser</a>
153 , the MITgcm code is continuously undergoing updates. At
154 points during the development (typically, after work has been done and the
155 source code has passed the <a href="./testing.html">verification
156 tests</a>), a release or checkpoint "tag" is created. These tags are a
157 convenient mechanism for referring to different times or points within the
158 development. One can check out these versions using the "-r TAG_NAME" CVS
159 option such as: </p>
160
161 <pre>
162 $ cvs co -P -r release1_p5 MITgcm
163 $ cvs co -P -r checkpoint52a_post MITgcm
164 </pre>
165
166 <p>By default (that is, when no tag is specified), CVS will retrieve the
167 latest version of all files. To download an older version corresponding
168 to a specific time, e.g., May 1rst, 2008, at 5pm, one can use the "-D"
169 CVS option as follows: </p>
170
171 <pre>
172 $ cvs co -P -D "2008-05-01 17:00" MITgcm
173 </pre>
174
175 <h4>Show changes that YOU have made</h4>
176
177 <p>If you are running into difficulties it is very useful to see the changes
178 that you yourself have made since obtaining the code. From within
179 your working directory:</p>
180
181 <pre>
182 cvs diff
183 </pre>
184
185
186 <p>will show the differences between your version and the version that you
187 checked out. It acts recursively on all directories below your current
188 directory. You can limit the operation to just one file or directory by
189 specifying those as arguments:</p>
190
191 <pre>
192 cvs diff <i>file</i>
193 </pre>
194
195
196 <h4>Show changes to the repository that you don't have</h4>
197
198 <p>The source code evolves continuously and you should try to stay up to
199 date. To see what needs to be updated:</p>
200
201 <pre>
202 cvs -n update
203 </pre>
204
205 <p>behaves just as "cvs update" but doesn't actually change anything. This
206 is a useful way of summarizing the state of your code. The meaning of the
207 output is summarized in the next topic.</p>
208
209 <h4>Getting updates from the repository</h4>
210
211 <p>You can download and merge updates from the repository to bring you
212 working code up to date:</p>
213
214 <pre>
215 cvs update -d -P
216 </pre>
217
218 <p>will work recursively on all files in the current directory and below.
219 To update just a specific file or directory:</p>
220
221 <pre>
222 cvs update <i>file</i>
223 </pre>
224
225 <p>You can also update to a specific version, just as you could check out
226 a specific version.</p>
227
228 <pre>
229 cvs update -d -P -r release1_p5
230 </pre>
231
232 <p>If you checked out a specific version and want to update to the very
233 latest use the -A option will remove associated with a specific version as
234 follows:</p>
235
236 <pre>
237 cvs update -d -P -A
238 </pre>
239
240 <p>"cvs update" produces output to the terminal with the following
241 meanings:</p>
242
243 <table align="center" border="0" cellpadding="10" width="90%" summary="CVS
244 update codes">
245 <tr bgcolor="#00cccc">
246 <td width="20%">Return Code</td>
247 <td>Description</td>
248 </tr>
249 <tr bgcolor="#bbffdd">
250 <td width="20%">U <i>file</i></td>
251 <td>indicates that <i>file</i> was brought up to date with the
252 repository or that it exists in the repository but not in your work
253 space</td>
254 </tr>
255 <tr bgcolor="#bbddff">
256 <td width="20%">P <i>file</td>
257 <td>does exactly as above but uses the "patch" method</td>
258 </tr>
259 <tr bgcolor="#bbffdd">
260 <td width="20%">M <i>file</i></td>
261 <td>means the <i>file</i> was modified in your work space. Any
262 additional changes from the repository were merged in
263 successfully</td>
264 </tr>
265 </tr>
266 <tr bgcolor="#bbddff">
267 <td width="20%">C <i>file</i></td>
268 <td>means a merge is necessary because both the your copy and the
269 repository have changed <b>but</b> there is a conflict between the
270 changes</td>
271 </tr>
272 <tr bgcolor="#bbffdd">
273 <td width="20%">? <i>file</i></td>
274 <td>means the file exists in your work space but not on the
275 repository</td>
276 </tr>
277 </table>
278
279 <p>When conflicts arise, the sections of code are both kept and surrounded
280 by &lt;&lt;&lt;&lt;&lt;, ===== and >>>>> indicators. You need to examine
281 these lines of the files and resolve the conflict.</p>
282
283 <h4>Wow! CVS is so good, where can I learn more?</h4>
284
285 <p>The <a
286 href="http://web.mit.edu/afs/athena.mit.edu/project/gnu/doc/html/cvs_toc.html">basic
287 manual</a> is a good reference.
288 For those who prefer the good old fashioned book there's
289 <a href="http://cvsbook.red-bean.com/">"Open Source Development With CVS"</a>.</p>
290
291 </body>
292 </html>
293

  ViewVC Help
Powered by ViewVC 1.1.22