/[MITgcm]/MITgcm/doc/devel_HOWTO.sgml
ViewVC logotype

Diff of /MITgcm/doc/devel_HOWTO.sgml

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

revision 1.16 by jmc, Sun Apr 24 00:04:40 2011 UTC revision 1.17 by jmc, Wed May 16 02:33:48 2012 UTC
# Line 232  Line 232 
232        MITgcm code (see: <ulink url="http://mitgcm.org/public/using_cvs.html">        MITgcm code (see: <ulink url="http://mitgcm.org/public/using_cvs.html">
233        using CVS </ulink>). The same tool is used by developers to        using CVS </ulink>). The same tool is used by developers to
234        incorporate any change into the repository. However, this later        incorporate any change into the repository. However, this later
235        function requires specific settings, as detailed here after:</para>        function requires specific settings, as detailed here after</para>
236        <orderedlist>        <orderedlist>
237          <listitem>          <listitem>
238            <para> You will need an account (loggin access) to the server            <para> You will need an account (login access) to the server
239             "mitgcm.org" with the proper group setting (e.g.,             "mitgcm.org" (curently: <filename>forge.csail.mit.edu</filename>)
240              group "gcmctrb" to add/modify code into MITgcm_contrib).             with the proper group setting (e.g., group "gcmctrb" to add/modify
241              This kind of account is granted only upon well motivated request.             code into MITgcm_contrib).
242              The access to the server mitgcm.org is through ssh-key authorization             This kind of account is granted only upon well motivated request
243              which will need to be set properly on both side (on your local machine             (we recommend to ask your senior MITgcm-collaborator to send such
244              and on your server account). You need to be able to             request to marshall-admin at techsquare.com with Cc to Chris Hill
245              to ssh to mitgcm.org (or <filename>ssh MY_USER_NAME@mitgcm.org</filename>             for approval).</para>
246              in case of different user-name on both sides) to proceed further.</para>            <para> The access to the server <filename>mitgcm.org</filename> is
247               through ssh-key authorization which will need to be set properly on
248               both side (on your local machine and on your server account).
249               You need to be able to ssh to <filename>mitgcm.org</filename>
250               (or <filename>ssh MY_USER_NAME@mitgcm.org</filename>
251               in case of different user-name on both sides) to proceed further.</para>
252          </listitem>          </listitem>
253    
254          <listitem>          <listitem>
255            <para> You need to register to the            <para> You need to register to the
256          <ulink url="http://mitgcm.org/mailman/listinfo/mitgcm-cvs">          <ulink url="http://mitgcm.org/mailman/listinfo/mitgcm-cvs">
257        mitgcm-cvs </ulink> mailing list.         mitgcm-cvs </ulink> mailing list.
258            This ensures that other developers will receive email notification            This ensures that other developers will receive email notification
259             when you make changes; you will also receive as well such email             when you make changes; you will also receive such email
260             when others make changes to the repository.             when others make changes to the repository.
261            </para>            </para>
262          </listitem>          </listitem>
# Line 259  Line 264 
264          <listitem>          <listitem>
265            <para> It is highly recommended that you register also to the            <para> It is highly recommended that you register also to the
266          <ulink url="http://mitgcm.org/mailman/listinfo/mitgcm-devel">          <ulink url="http://mitgcm.org/mailman/listinfo/mitgcm-devel">
267        mitgcm-devel </ulink> mailing list (expect a short delay for         mitgcm-devel </ulink> mailing list (expect a short delay for
268         this request to be processed).         this request to be processed).
269            This list is intended for developer discussions.            This list is intended for developer discussions.
270            </para>            </para>
271          </listitem>          </listitem>
272    
273          <listitem>          <listitem>
274            <para> The standard anonymous mode (using "cvsanon", as mentionned            <para> The standard CVS-anonymous mode (using "cvsanon",
275          <ulink url="http://mitgcm.org/public/source_code.html">          as mentionned <ulink url="http://mitgcm.org/public/source_code.html">
276        here </ulink>) does not allow check-in ("cvs commit") permission.          here </ulink>) does not provide check-in ("cvs commit") permission.
277           Instead, you will need to set our CVS environment as follow:</para>           Instead, you will need to set our CVS environment as follow:</para>
278  <screen>  <screen>
279    $ export CVS_RSH=ssh    $ export CVS_RSH=ssh
280    $ export CVSROOT=':ext:MY_USER_NAME@mitgcm.org:/u/gcmpack'    $ export CVSROOT=':ext:MY_USER_NAME@mitgcm.org:/u/gcmpack'
281  </screen>  </screen>
282            <para> After downloading a directory, e.g.: <filename>myCopy</filename>,            <para> The reason for such limitation is that when downloading a directory,
283             from the CVS repository (e.g.,              e.g.: <filename>myCopy</filename>, from the CVS repository (e.g.,
284              <filename>MITgcm_contrib/thisPart</filename>) using the command:</para>              <filename>MITgcm_contrib/thisPart</filename>) using the command:</para>
285  <screen>  <screen>
286    $ cvs co -P -d myCopy MITgcm_contrib/thisPart    $ cvs co -P -d myCopy MITgcm_contrib/thisPart
287  </screen>  </screen>
288            <para> the type of CVS environment which has been used            <para> the type of CVS environment which has been used
289             is stored in the file <filename>myCopy/CVS/Root</filename>             is stored in the file <filename>myCopy/CVS/Root</filename>.
290             and makes it difficult to re-use, for cvs-commit purpose,             This prevent to re-use, for cvs-commit purpose,
291             a cvs local copy (<filename>myCopy</filename>) which was obtained             a cvs local copy (<filename>myCopy</filename>) which was obtained
292             using the CVS anonymous mode.</para>             using the CVS anonymous mode.</para>
293          </listitem>          </listitem>
# Line 303  Line 308 
308            changes you made to <filename>src_file</filename> as you check-in            changes you made to <filename>src_file</filename> as you check-in
309            this file (the "cvs commit" command automatically opens your standard            this file (the "cvs commit" command automatically opens your standard
310            editor for this purpose).</para>            editor for this purpose).</para>
311              <para> Note:
312               Please ignore the following warnings that the "cvs commit" command
313               produces if you are not part of the "gcmpack" group:
314    <screen>
315       cvs commit: failed to create lock directory for `/u/gcmpack/CVSROOT'
316       (/u/gcmpack/CVSROOT/#cvs.history.lock): Permission denied
317       cvs commit: failed to obtain history lock in repository `/u/gcmpack'
318    </screen>
319              These warnings are not affecting the changes you made to the CVS repository.
320              </para>
321          </listitem>          </listitem>
322    
323        </orderedlist>        </orderedlist>
Legend:
Removed from v.1.16  
changed lines
  Added in v.1.17
  ViewVC Help
Powered by ViewVC 1.1.22