ViewVC logotype

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

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

Revision 1.1 - (show annotations) (download) (as text)
Thu Dec 4 02:14:52 2003 UTC (17 years, 9 months ago) by edhill
Branch: MAIN
File MIME type: text/xml
 o complete re-work

1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
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" />
10 <!-- Hinting for menu generation -->
11 <meta name="add_name_0" content="Source Code" />
12 <meta name="add_name_1" content="CVS Policy" />
13 <meta name="add_name_2" content="" />
14 <meta name="add_title" content="CVS Policy" />
15 <!-- Hinting for menu generation -->
17 <title>MITgcm: <!--ADDTITLE--></title>
18 <style type="text/css">
19 span.c2 {font-size: 110%}
20 div.c1 {text-align: center}
21 </style>
22 </head>
24 <body>
26 <center>
27 <h3>MITgcm CVS policy</h3>
28 </center>
30 <h4>Introduction</h4>
32 This note describes policies that apply to the MITGCM CVS repository.
34 <h4>Why have a policy?</h4>
36 <p>CVS itself is a liberal free-for-all product that can be used in a
37 variety of ways. It is designed to provide a system for storing arbitrary
38 files in a way that allows the change history of the individual files to
39 be tracked. If CVS is used without any other policy the result can be a
40 collection of files each of which has complex, multiply branched set of
41 inter-related versions. This sort of CVS repository can be come like a
42 library where books are simply stored in a huge heap. Although nothing is
43 actually lost, the task of finding a coherent collection of material soon
44 becomes impossible.</p>
46 <p>The policies we employ address tree areas
47 <ol>
49 <li>Maintaining an orderly and easily identifiable, coherent set of
50 evolving "products".</li>
52 <li>Allowing concurrent, on-going development of product
53 components.</li>
55 <li>Making the integration of achieved developments easy, rapid,
56 organized and clear.</li>
57 </ol>
58 </p>
60 <h4>Development trees and checkpoint trees</h4>
62 <p>A directory within the MITGCM repository resides under either the development
63 branch or the checkpoint branch. Files within each branch follow different
64 policies.</p>
66 <h4>Development tree policies</h4>
68 <p>Development trees are intended to be flexible areas where arbitrary files
69 can be stored with multiple versions, many branches supporting multiple
70 ongoing streams of development. Development trees have no policies in
71 place to control complexity. Development trees might be associated with a
72 particular person, a certain project or a particular special piece of
73 work. These trees are intended to be useful areas for storing current work
74 and for archiving partially finished work so that it doesn't get mislaid
75 and so that some record of the development history can be easily
76 maintained. The only policy that applies to development trees is that this
77 style of tree is not intended to be used for providing a "checkpoint"
78 distribution. Tagged configurations of tools built from this style of tree
79 can be distributed, but because these trees do not have any policies
80 regarding testing of functionality, platform coverage or documentation
81 these trees are not allowed to form the basis of "checkpoint"
82 distributions or formal "releases". Other policies can be defined by
83 individuals users of these trees but there are no further global
84 policies. The MITGCM repository development_tree/ sub-directory is
85 reserved for holding development trees. Development trees also serve as
86 experimental areas for exploring new code management policies.</p>
88 <h4>Checkpoint tree policies</h4>
90 <p>Checkpoint trees are intended to provide structured storage areas for
91 holding code that is intended for open distribution and is to be readily
92 downloaded. There are policies governing the operation of these trees
93 which are designed to ensure that distributed codes are early identified
94 and meet certain levels of quality.
95 <ol>
96 <li><b>Check-out:</b> Just do it! Two mechanisms are available. cvsanon for
97 read only access and regular cvs co .... for read/write access.</li>
99 <li><b>Check-in</b>: The code check in procedure for a "checkpoint" tree
100 is as follows
102 <ol>
103 <li>Check out the latest main branch revision.</li>
105 <li>Merge your changes into that revision.</li>
107 <li>Build and validate new code.</li>
109 <li>Check that there have been no further changes to the
110 repository. Repeat from 2.1 if repository has changed.</li>
112 <li>Get clearance from other developers to check in your
113 changes.</li>
115 <li>Check in your changed main branch.</li>
117 <li>Build and validate the new changes.</li>
119 <li>Tag code as "checkpointNN". Add records to docs/tag-index.</li>
121 <li>Build and validate test cases (see testing).</li>
123 <li>Create and install checkpointNN.tar.gz</li>
124 </ol>
126 <li><b>Testing</b>: Things in a checkpoint tree require a test case
127 that can be used to validate the component.</li>
129 <li><b>Checkpoint tagging</b>: No code should be left in limbo
130 (un-tagged) for extended periods. On the other hand it's unnecessary
131 to create a checkpoint tag for every little change. Checkpoint tags
132 should be made after a particularly significant code modification or
133 otherwise on a regular basis, say bi-weekly. Very often we set a
134 list of goals to be reached by the next checkpoint which sometimes
135 takes more than two weeks to achieve. Obviously, in this case a
136 bi-weekly checkpoint would not be useful.</li>
138 <li><b>Release tagging</b>: Releases are only based on checkpoint tree
139 code. Maintenance fixes to releases are also maintained within the
140 checkpoint tree. Files within a release must have accompanying
141 documentation. The form of this documentation depends on the file
142 type.</li>
144 <li><b>Branches</b>: Branches are a useful tool for making changes
145 prior to checkpoints without breaking other working versions but it
146 must be understood that branches are short-lived and that releases
147 and checkpoints not be made from a branch. Branches are especially
148 useful for adding totally <br>new features. bug-fixes to checkpoints
149 are introduced by moving checkpoint levels forward. The only
150 historical code maintenance that s employed is for fixes and patches
151 to formal releases - not checkpoints.</li>
152 </ol>
154 <h4>Someone checked-in broken code so not my code doesn't work?</h4>
156 <p>You have several options:
157 <ol>
158 <li>Politely email everyone at support@mitgcm.org asking what has
159 happened and that it be fixed?</li>
161 <li>Figure out why the new code is broken, fix it, check it in and
162 proudly send a message to support@mitgcm.org to show how
163 constructive you are.</li>
165 <li>Complain that the quality of work is too low and then do nothing
166 to fix the code.</li>
167 </ol>
168 </p>
170 <p>We advise you to only use the third option if you are confident that
171 your own contributions to the code are bug-free, well written,
172 documented and fool proof.&nbsp; :)</p>
174 <h4>These policies are causing me a big problem, what can I do?</h4>
176 <p>The policies are not enforced by any mechanism other than mutual
177 agreement! If you think the policies are not appropriate then let us
178 know and we can discuss changing them. However, if you simply ignore the
179 policies regarding the checkpoint_release trees then your code may be
180 removed and/or your access revoked.</p>
182 <!--
183 <h4>What about bitkeeper</h4>
185 <p>We are looking at bitkeeper (www.bitkeeper.com). It looks cool, but
186 policies are still important. Any experience, suggestions let us
187 know. Watch this space!</p>
188 -->
189 <h4>Questions</h4>
191 <p>If you have any questions or suggestions please contact the MITgcm
192 developers at <a href="mailto:MITgcm-support@mitgcm.org">
193 MITgcm-support@mitgcm.org</a></p>
195 </body>
196 </html>

  ViewVC Help
Powered by ViewVC 1.1.22