source: LMDZ5/trunk/tools/fcm/doc/release_notes/1-2.html @ 5431

Last change on this file since 5431 was 1578, checked in by jghattas, 13 years ago
  • Add fcm in LMDZ5/tools directory

It is no longer needed to have fcm in your environement PATH variable.
Now makelmdz_fcm takes by default this fcm. It is still possible to use
another fcm, using -fcm_path argument in makelmdz_fcm.
File size: 13.8 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5  <title>FCM 1.2 Release Notes</title>
6  <meta name="author" content="FCM development team">
7  <meta name="descriptions" content="FCM Release Notes">
8  <meta name="keywords" content="FCM, release">
9  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
10  <link rel="stylesheet" type="text/css" href="style.css">
11</head>
12
13<body>
14  <h1>FCM 1.2 Release Notes<br>
15  22 March 2007</h1>
16
17  <p>These are the release notes for FCM release 1.2. You can use this release
18  of FCM freely under the terms of the <a href="../../LICENSE.html">FCM
19  LICENSE</a>, which you should receive with this distribution.</p>
20
21  <p>FCM is maintained by the FCM team at the Met Office. Please feedback any
22  bug reports or feature requests to us by <a href=
23  "mailto:fcm-team@metoffice.gov.uk">e-mail</a>.</p>
24
25  <h2>Contents</h2>
26
27  <ul>
28    <li><a href="#new">What's New?</a></li>
29
30    <li><a href="#fix">Minor enhancements &amp; Bug Fixes</a></li>
31
32    <li><a href="#req">System Requirements</a></li>
33
34    <li><a href="#ins">Installation</a></li>
35  </ul>
36
37  <h2><a name="new" id="new">What's New?</a></h2>
38
39  <p>Code management commands:</p>
40
41  <ul>
42    <li>New options <tt>--trac</tt> and <tt>--wiki</tt> for <tt>fcm diff
43    --branch</tt>.</li>
44
45    <li>Allow other graphical diff tools to be used in place of <em>xxdiff</em>.
46    </li>
47  </ul>
48
49  <p>General:</p>
50
51  <ul>
52    <li>New document <em>External Distribution &amp; Collaboration for FCM
53    Projects</em>.</li>
54  </ul>
55
56  <h2><a name="fix" id="fix">Minor enhancements &amp; Bug Fixes</a></h2>
57
58  <p>Build system:</p>
59
60  <ul>
61    <li>Extra warnings when multiple targets are detected in the source
62    tree.</li>
63
64    <li>Improved the patterns for detecting <em>recursive</em>, <em>pure</em>
65    and <em>elemental</em> Fortran subroutines and functions.</li>
66  </ul>
67
68  <p>Code management commands:</p>
69
70  <ul>
71    <li><tt>fcm branch --list</tt> now prints the branches using FCM URL
72    keywords by default. Use the <tt>--verbose</tt> option to print branches
73    in full Subversion URLs.</li>
74  </ul>
75
76  <p>General:</p>
77
78  <ul>
79    <li>Enhanced <tt>fcm cmp-ext-cfg</tt> to link to tickets.</li>
80
81    <li>Improved handling of FCM URL keywords. The <tt>SET::REPOS</tt>
82    declaration in the central/user configuration file is deprecated in favour
83    of <tt>SET::URL</tt>. The keyword of the project with the standard suffices
84    (<tt>_tr</tt> or <tt>-tr</tt> for "trunk", <tt>_br</tt> or <tt>-br</tt> for
85    "branches", and <tt>_tg</tt> or <tt>-tg</tt> for "tags") are recognised
86    automatically.</li>
87
88    <li>Fix: full extract/build should no longer delete one another's cache if
89    they are run in the same directory.</li>
90
91    <li>Various other very minor enhancements and bug fixes.</li>
92  </ul>
93
94  <h2><a name="req" id="req">System Requirements</a></h2>
95
96  <h3><a name="req_perl" id="req_perl">Perl</a></h3>
97
98  <p>The core part of FCM is a set of Perl scripts and modules. For the build
99  system to work, you need the following modules installed:</p>
100
101  <ul>
102    <li class="mono">Carp</li>
103
104    <li class="mono">Cwd</li>
105
106    <li class="mono">File::Basename</li>
107
108    <li class="mono">File::Compare</li>
109
110    <li class="mono">File::Find</li>
111
112    <li class="mono">File::Path</li>
113
114    <li class="mono">File::Spec::Functions</li>
115
116    <li class="mono">File::Spec</li>
117
118    <li class="mono">FindBin</li>
119
120    <li class="mono">Getopt::Long</li>
121
122    <li class="mono">POSIX</li>
123  </ul>
124
125  <p>The code management commands and extract system need the following
126  additional modules installed:</p>
127
128  <ul>
129    <li class="mono">File::Temp</li>
130
131    <li class="mono">Getopt::Long</li>
132
133    <li class="mono">HTTP::Date</li>
134
135    <li class="mono">XML::DOM</li>
136  </ul>
137
138  <p>To use the simple GUI for some of the code management commands, you also
139  need the following modules:</p>
140
141  <ul>
142    <li class="mono">Tk::ROText</li>
143
144    <li class="mono">Tk</li>
145  </ul>
146
147  <p>At the Met Office we are currently using the complete FCM system with Perl
148  5.8.x. In addition the build system is being used with Perl 5.6.x.</p>
149
150  <h3><a name="req_svn" id="req_svn">Subversion</a></h3>
151
152  <p>To use the code management commands (and relevant parts of the extract
153  system) you need to have <a href=
154  "http://subversion.tigris.org/">Subversion</a> installed.</p>
155
156  <ul>
157    <li>FCM makes extensive use of peg revisions in both the code management
158    and extract systems. This requires Subversion 1.2.0.</li>
159
160    <li>At the Met Office we are currently using Subversion 1.3.2.</li>
161  </ul>
162
163  <p>Note that the extract system can mirror extracted code to a remote
164  platform for building. Therefore it is only necessary to have Subversion
165  installed on the platform where you do your code development. If you use
166  other platforms purely for building and running then you do not need to have
167  Subversion installed on these platforms.</p>
168
169  <h3><a name="req_trac" id="req_trac">Trac</a></h3>
170
171  <p>The use of <a href="http://projects.edgewall.com/trac/">Trac</a> is
172  entirely optional (although highly recommended if you are using Subversion).
173  </p>
174
175  <ul>
176    <li>The <tt>--trac</tt> and <tt>--wiki</tt> options to the <tt>fcm diff
177    --branch</tt> command allow you to view branch differences using Trac. This
178    requires Trac 0.10.</li>
179
180    <li>At the Met Office we are currently using Trac 0.10.3.</li>
181  </ul>
182
183  <h3><a name="req_other" id="req_other">Other Requirements</a></h3>
184
185  <p>The <tt>fcm conflicts</tt> command requires <a href=
186  "http://furius.ca/xxdiff/">xxdiff</a>. At the Met Office we are currently
187  using version 3.1. The <tt>fcm diff --graphical</tt> command also uses xxdiff
188  by default although other graphical diff tools can also be used.</p>
189
190  <p>The build system requires <a href=
191  "http://www.gnu.org/software/make/make.html">GNU make</a>. At the Met Office
192  we are currently using version 3.79.x and 3.80.</p>
193
194  <p>Optionally, the build system can use <a href=
195  "http://www.ifremer.fr/ditigo/molagnon/fortran90">f90aib</a> to generate
196  interface files. However, there is also a built in Perl based interface file
197  generator which is quicker and better in most cases so you are unlikely to
198  need f90aib unless you hit a problem with some particular code.</p>
199
200  <p>FCM is intended to run on a Unix/Linux system. It is currently used at the
201  Met Office on Linux (Red Hat Enterprise 2.1 and 4.4) and HP-UX 11.00.</p>
202
203  <h2><a name="ins" id="ins">Installation</a></h2>
204
205  <p>FCM is distributed in the form of a compressed tar file. Un-pack the tar
206  file into an appropriate location on your system. Then add the <tt>bin</tt>
207  directory into your PATH. Once you have done this you should now have full
208  access to the FCM system, assuming that you have met the requirements
209  described in the previous section.</p>
210
211  <p>If you wish to define keywords for your systems you will need to create a
212  file <tt>etc/fcm.cfg</tt>. An example file, <tt>fcm.cfg.eg</tt>, is provided
213  which is a copy of the file currently used at the Met Office. For further
214  details please refer to the section <a href=
215  "../user_guide/system_admin.html#fcm-keywords">FCM keywords</a> in the System
216  Admin chapter of the User Guide.</p>
217
218  <p>The <tt>doc</tt> directory contains all the system documentation.</p>
219
220  <ul>
221    <li><tt>doc/release_notes</tt> contains these release notes. It also
222    contains the release notes for all previous versions which may be useful if
223    you have skipped any versions.</li>
224
225    <li><tt>doc/user_guide</tt> contains the <a href="../user_guide/index.html">
226    FCM User Guide</a>.</li>
227
228    <li><tt>doc/design</tt> contains the <a href="../design/index.html">FCM
229    Detailed Design</a> document (currently in draft form).</li>
230
231    <li><tt>doc/standards</tt> contains the FCM <a href=
232    "../standards/perl_standard.html">Perl</a> and <a href=
233    "../standards/fortran_standard.html">Fortran</a> coding standards. The Perl
234    standard describes the standards followed by the FCM code. The Fortran
235    standard contains some <a href=
236    "../standards/fortran_standard.html#fcm">specific advice</a> on the best
237    way of writing Fortran code for use with FCM as well as more general advice
238    on good practise.</li>
239
240    <li><tt>doc/collaboration</tt> contains the <a href=
241    "../collaboration/index.html">External Distribution &amp; Collaboration for
242    FCM Projects</a> document which discusses how projects configured under FCM
243    can be distributed externally.</li>
244  </ul>
245
246  <p>The <tt>tutorial</tt> directory contains the files necessary to set up a
247  tutorial repository. This will allow you to follow the <a href=
248  "../user_guide/getting_started.html#tutorial">tutorial section</a> in the
249  User Guide.</p>
250
251  <ul>
252    <li>The file <tt>tutorial/repos/tutorial.dump</tt> should be loaded into an
253    empty repository using the <tt>svnadmin load</tt> command.</li>
254
255    <li>The hook scripts in <tt>tutorial/hook</tt> should then be installed in
256    this repository in order to prevent any commits to the trunk. Note that the
257    configuration file <tt>svnperms.conf</tt> assumes that the tutorial
258    repository is called <tt>tutorial_svn</tt>. Please edit this file if you
259    use a different name.</li>
260
261    <li>The repository should be configured to allow users write access. You
262    may find it easiest to simply allow anonymous access.</li>
263
264    <li>A Trac system should be configured associated with the Tutorial
265    repository. You then need to allow users write access. You may find it
266    easiest to set up a number of guest accounts for this purpose.</li>
267  </ul>
268
269  <p>The <tt>templates</tt> directory contains various example scripts which
270  you may find useful. Note that these scripts are all specific to the Met
271  Office and may contain hard coded paths and email addresses. They are
272  provided in the hope that you may find them useful as templates for setting
273  up similar scripts of your own. However, they should only be used after
274  careful review to adapt them to your environment. The contents are as
275  follows:</p>
276
277  <table summary="list of template scripts" border="1" width="100%">
278    <tr>
279      <th>Script</th>
280
281      <th>Description</th>
282    </tr>
283
284    <tr>
285      <th>templates/hook/pre-commit</th>
286
287      <td>
288        This script restricts write-access to the repository by checking the
289        following:
290
291        <ul>
292          <li>It executes the Subversion utility <tt>svnperms.py</tt> if it
293          exists. This utility checks whether the author of the current
294          transaction has enough permission to write to particular paths in the
295          repository.</li>
296
297          <li>It checks the disk space required by the current transaction. It
298          fails the commit if it requires more than 5Mb of disk space.</li>
299        </ul>
300      </td>
301    </tr>
302
303    <tr>
304      <th>templates/hook/post-commit</th>
305
306      <td>A simple post-commit hook script which runs the script
307      <tt>post-commit-background</tt> in the background.</td>
308    </tr>
309
310    <tr>
311      <th>templates/hook/post-commit-background</th>
312
313      <td>
314        This script runs in the background after each commit
315
316        <ul>
317          <li>It updates a <tt>&lt;repos&gt;.latest</tt> file with the latest
318          revision number.</li>
319
320          <li>It creates a dump of the new revision.</li>
321
322          <li>It calls the script <tt>background_updates.pl</tt> if it
323          exists.</li>
324        </ul>This script is installed as standard in all our repositories.
325      </td>
326    </tr>
327
328    <tr>
329      <th>templates/hook/background_updates.pl</th>
330
331      <td>An example of how you may want to set up a
332      <tt>background_updates.pl</tt> script to perform post-commit tasks for a
333      specific repository. This script uses a lock file to prevent multiple
334      commits in quick succession from causing problems.</td>
335    </tr>
336
337    <tr>
338      <th>templates/hook/pre-revprop-change</th>
339
340      <td>A simple pre-revprop-change hook script which runs the script
341      <tt>pre-revprop-change.pl</tt>.</td>
342    </tr>
343
344    <tr>
345      <th>templates/hook/pre-revprop-change.pl</th>
346
347      <td>If a user attempts to modify the log message of a changeset and
348      he/she is not the original author of the changeset, this script will
349      e-mail the original author. You can also set up a watch facility to
350      monitor changes of log messages that affect particular paths in the
351      repository. For further details please refer to the section <a href=
352      "../user_guide/system_admin.html#svn_watch">Watching changes in log
353      messages</a> in the System Admin chapter of the User Guide.</td>
354    </tr>
355
356    <tr>
357      <th>templates/hook/post-revprop-change</th>
358
359      <td>A simple post-revprop-change hook script which runs the script
360      <tt>post-revprop-change.py</tt>.</td>
361    </tr>
362
363    <tr>
364      <th>templates/hook/post-revprop-change.py</th>
365
366      <td>This hook script updates the Trac SQLite database following a
367      successful change in the log message.</td>
368    </tr>
369
370    <tr>
371      <th>templates/utils/cron_template.ksh</th>
372
373      <td>An example of how you might set up a cron job to make use of the
374      <tt>&lt;repos&gt;.latest</tt> file.</td>
375    </tr>
376
377    <tr>
378      <th>templates/utils/daily_cron</th>
379
380      <td>The cron job which we run each night. It verifies and backs up each
381      of our repositories, housekeeps the revision dumps created by
382      <tt>post-commit-background</tt> and backs up each of our Trac systems. It
383      also handles the distribution of FCM to various platforms at the Met
384      Office.</td>
385    </tr>
386
387    <tr>
388      <th>templates/utils/fcm_add_trac.pl</th>
389
390      <td>This script sets up a new Trac system and applies some configuration
391      options which we use by default at the Met Office.</td>
392    </tr>
393
394    <tr>
395      <th>templates/utils/recover_svn.pl</th>
396
397      <td>This script allows us to recover all of our Subversion repositories
398      by using the nightly backups and the repository dumps.</td>
399    </tr>
400  </table>
401</body>
402</html>
Note: See TracBrowser for help on using the repository browser.