source: LMDZ6/branches/Amaury_dev/tools/fcm/doc/release_notes/1-4.html @ 5110

Last change on this file since 5110 was 5095, checked in by abarral, 17 months ago

Revert cosp*/ from the trunk, as it's external code
Add missing bits from FCM2 source
File size: 14.4 KB
Line 
1<!DOCTYPE html>
2<html>
3<head>
4  <title>FCM 1.4 Release Notes</title>
5  <meta name="author" content="FCM team" />
6  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7  <link rel="icon" href="../etc/fcm-icon.png" type="image/png" />
8  <link rel="shortcut icon" href="../etc/fcm-icon.png" type="image/png" />
9  <link href="../etc/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen" />
10  <link href="../etc/fcm.css" rel="stylesheet" media="screen" />
11</head>
12<body>
13  <div class="navbar navbar-inverse">
14    <div class="container-fluid">
15      <div class="navbar-header">
16        <a class="navbar-brand" href=".."><span class="fcm-version">FCM</span></a>
17      </div>
18      <div class="collapse navbar-collapse">
19        <ul class="nav navbar-nav">
20          <li><a href="../installation/">Installation</a></li>
21
22          <li><a href="../user_guide/">User Guide</a></li>
23        </ul>
24      </div>
25    </div>
26  </div>
27
28  <div class="page-header">
29    <div class="fcm-page-content pull-right well well-sm"></div>
30    <h1>FCM 1.4 Release Notes <small>12 February 2009</small></h1>
31  </div>
32
33  <div class="container">
34  <div class="row">
35  <div class="col-md-12">
36
37  <p>These are the release notes for FCM release 1.4. You can use this release
38  of FCM freely under the terms of the FCM LICENSE, which you should receive
39  with the distribution of this release.</p>
40
41  <p>Note that FCM 1.4 requires Subversion 1.4.x (but it has not been tested on
42  Subversion 1.5.x or above).</p>
43
44  <p>FCM is maintained by the FCM team at the Met Office. Please feedback any
45  bug reports or feature requests to us by <a href=
46  "mailto:fcm-team@metoffice.gov.uk">e-mail</a>.</p>
47
48  <h2 id="fix">Minor enhancements &amp; Bug Fixes</h2>
49
50  <p>Build:</p>
51
52  <ul>
53    <li>Fixed: ensure consistent behaviour for specifying <code>-D</code>,
54    <code>-I</code>, etc options for a preprocessor/compiler.</li>
55  </ul>
56
57  <p>Code management commands:</p>
58
59  <ul>
60    <li>Fixed: <code>fcm mkpatch</code>: Fix how property changes are
61    handled.</li>
62
63    <li>Fixed: <code>fcm mkpatch</code>: Fix how copied files and directories
64    are handled.</li>
65
66    <li>Fixed: <code>fcm mkpatch</code>: Prevent failures caused by the use of
67    Subversion keywords.</li>
68
69    <li>Fixed: <code>fcm mkpatch</code>: Prevent failures when used with
70    branches which do not follow the FCM naming convention.</li>
71  </ul>
72
73  <p>Extract:</p>
74
75  <ul>
76    <li>Allow extract config to define an alternate remote shell for
77    <code>rsync</code>.</li>
78  </ul>
79
80  <p>General:</p>
81
82  <ul>
83    <li>Some of the example scripts in the <samp>templates/</samp> directory
84    have been rewritten.</li>
85
86    <li>Various other very minor enhancements and bug fixes.</li>
87  </ul>
88
89  <h2 id="issues">Known Issues</h2>
90
91  <p>The following are known issues with this release of FCM which we plan to
92  address in later releases:</p>
93
94  <ul>
95    <li>FCM build does not handle changes in an include file correctly in an
96    inherited build if the include file resides in the same directory as the
97    source file including it, and the source file remains unchanged. This is
98    due to the fact that most pre-processor/compiler commands search the
99    directory containing the source file for include files first before they
100    search elsewhere.</li>
101  </ul>
102
103  <h2 id="req">System Requirements</h2>
104
105  <h3 id="req_perl">Perl</h3>
106
107  <p>The core part of FCM is a set of Perl scripts and modules. For the build
108  system to work, you need the following modules installed:</p>
109
110  <ul>
111    <li>Carp</li>
112
113    <li>Cwd</li>
114
115    <li>File::Basename</li>
116
117    <li>File::Compare</li>
118
119    <li>File::Find</li>
120
121    <li>File::Path</li>
122
123    <li>File::Spec::Functions</li>
124
125    <li>File::Spec</li>
126
127    <li>FindBin</li>
128
129    <li>Getopt::Long</li>
130
131    <li>POSIX</li>
132  </ul>
133
134  <p>The code management commands and extract system need the following
135  additional modules installed:</p>
136
137  <ul>
138    <li>File::Temp</li>
139
140    <li>Getopt::Long</li>
141
142    <li>HTTP::Date</li>
143
144    <li>XML::DOM</li>
145  </ul>
146
147  <p>To use the simple GUI for some of the code management commands, you also
148  need the following modules:</p>
149
150  <ul>
151    <li>Tk::ROText</li>
152
153    <li>Tk</li>
154  </ul>
155
156  <p>At the Met Office we are currently using the complete FCM system with Perl
157  5.8.x. In addition the build system is being used with Perl 5.6.x.</p>
158
159  <h3 id="req_svn">Subversion</h3>
160
161  <p>To use the code management commands (and relevant parts of the extract
162  system) you need to have <a href=
163  "http://subversion.tigris.org/">Subversion</a> installed.</p>
164
165  <ul>
166    <li>FCM makes extensive use of peg revisions in both the code management
167    and extract systems. This requires Subversion 1.4.0.</li>
168
169    <li>At the Met Office we are currently using Subversion 1.4.3.</li>
170  </ul>
171
172  <p>Note that the extract system can mirror extracted code to a remote
173  platform for building. Therefore it is only necessary to have Subversion
174  installed on the platform where you do your code development. If you use
175  other platforms purely for building and running then you do not need to have
176  Subversion installed on these platforms.</p>
177
178  <h3 id="req_trac">Trac</h3>
179
180  <p>The use of <a href="http://trac.edgewall.org/">Trac</a> is entirely
181  optional (although highly recommended if you are using Subversion).</p>
182
183  <ul>
184    <li>The <code>--trac</code> and <code>--wiki</code> options to the
185    <code>fcm diff --branch</code> command allow you to view branch differences
186    using Trac. This requires Trac 0.10.</li>
187
188    <li>Some of the example scripts in the <samp>templates/</samp> directory
189    require Trac 0.11.</li>
190
191    <li>At the Met Office we are currently using Trac 0.11.2.1.</li>
192  </ul>
193
194  <h3 id="req_other">Other Requirements</h3>
195
196  <p>The <code>fcm conflicts</code> command requires <a href=
197  "http://furius.ca/xxdiff/">xxdiff</a>. At the Met Office we are currently
198  using version 3.1. The <code>fcm diff --graphical</code> command also uses
199  xxdiff by default although other graphical diff tools can also be used.</p>
200
201  <p>The extract system can use diff3, which is part of <a href=
202  "http://www.gnu.org/software/diffutils/">GNU diffutils</a>, to merge together
203  changes where the same file is modified by two different branches (compared
204  with the base branch). At the Met Office we are currently using version
205  2.8.1.</p>
206
207  <p>The build system requires <a href=
208  "http://www.gnu.org/software/make/make.html">GNU make</a>. At the Met Office
209  we are currently using version 3.79.x and 3.80.</p>
210
211  <p>Optionally, the build system can use <a href=
212  "http://www.ifremer.fr/ditigo/molagnon/fortran90/">f90aib</a> to generate
213  interface files. However, there is also a built in Perl based interface file
214  generator which is quicker and better in most cases so you are unlikely to
215  need f90aib unless you hit a problem with some particular code.</p>
216
217  <p>FCM is intended to run on a Unix/Linux system. It is currently used at the
218  Met Office on Linux (Red Hat Enterprise 2.1 and 4.6) and HP-UX 11.00.</p>
219
220  <h2 id="ins">Installation</h2>
221
222  <p>FCM is distributed in the form of a compressed tar file. Un-pack the tar
223  file into an appropriate location on your system. Then add the
224  <samp>bin/</samp> directory into your <var>PATH</var>. Once you have done
225  this you should now have full access to the FCM system, assuming that you
226  have met the requirements described in the previous section.</p>
227
228  <p>If you wish to define keywords for your systems you will need to create a
229  file <samp>etc/fcm.cfg</samp>. An example file, <samp>fcm.cfg.eg</samp>, is
230  provided which is a copy of the file currently used at the Met Office. For
231  further details please refer to the section <a href=
232  "../user_guide/system_admin.html#fcm-keywords">FCM keywords</a> in the System
233  Admin chapter of the User Guide.</p>
234
235  <p>The <samp>doc/</samp> directory contains all the system documentation.</p>
236
237  <ul>
238    <li><samp>doc/release_notes/</samp> contains these release notes. It also
239    contains the release notes for all previous versions which may be useful if
240    you have skipped any versions.</li>
241
242    <li><samp>doc/user_guide/</samp> contains the <a href="../user_guide/">FCM
243    User Guide</a>.</li>
244
245    <li><samp>doc/design/</samp> contains the <a href="../design/">FCM Detailed
246    Design</a> document (currently in draft form).</li>
247
248    <li><samp>doc/standards/</samp> contains the FCM <a href=
249    "../standards/perl_standard.html">Perl</a> and <a href=
250    "../standards/fortran_standard.html">Fortran</a> coding standards. The Perl
251    standard describes the standards followed by the FCM code. The Fortran
252    standard contains some <a href=
253    "../standards/fortran_standard.html#fcm">specific advice</a> on the best
254    way of writing Fortran code for use with FCM as well as more general advice
255    on good practise.</li>
256
257    <li><samp>doc/collaboration/</samp> contains the <a href=
258    "../collaboration/index.html">External Distribution &amp; Collaboration for
259    FCM Projects</a> document which discusses how projects configured under FCM
260    can be distributed externally.</li>
261  </ul>
262
263  <p>The <samp>tutorial/</samp> directory contains the files necessary to set
264  up a tutorial repository. This will allow you to follow the <a href=
265  "../user_guide/getting_started.html#tutorial">tutorial section</a> in the
266  User Guide.</p>
267
268  <ul>
269    <li>The file <samp>tutorial/svn.dump</samp> should be loaded into an empty
270    repository using the <code>svnadmin load</code> command.</li>
271
272    <li>The hook scripts in <samp>tutorial/hooks/</samp> should then be
273    installed in this repository in order to prevent any commits to the trunk.
274    Note that the configuration file <code>svnperms.conf</code> assumes that
275    the tutorial repository is called <samp>tutorial_svn</samp>. Please edit
276    this file if you use a different name.</li>
277
278    <li>The repository should be configured to allow users write access. You
279    may find it easiest to simply allow anonymous access.</li>
280
281    <li>A Trac system should be configured associated with the Tutorial
282    repository. You then need to allow users write access. You may find it
283    easiest to set up a number of guest accounts for this purpose.</li>
284  </ul>
285
286  <p>The <samp>templates/</samp> directory contains various example scripts
287  which you may find useful. Note that these scripts are all specific to the
288  Met Office and may contain hard coded paths and email addresses. They are
289  provided in the hope that you may find them useful as templates for setting
290  up similar scripts of your own. However, they should only be used after
291  careful review to adapt them to your environment. The contents are as
292  follows:</p>
293
294  <dl>
295    <dt>templates/hooks/pre-commit</dt>
296
297    <dd>
298      This script restricts write-access to the repository by checking the
299      following:
300
301      <ul>
302        <li>It executes the Subversion utility <code>svnperms.py</code> if it,
303        and the associated <samp>svnperms.conf</samp> file, exist. This utility
304        checks whether the author of the current transaction has enough
305        permission to write to particular paths in the repository.</li>
306
307        <li>It checks the disk space required by the current transaction. It
308        fails the commit if it requires more than 5Mb of disk space.</li>
309      </ul>
310    </dd>
311
312    <dt>templates/hooks/post-commit</dt>
313
314    <dd>A simple post-commit hook script which runs the script
315    <code>post-commit-background</code> in the background.</dd>
316
317    <dt>templates/hooks/post-commit-background</dt>
318
319    <dd>
320      This script runs in the background after each commit
321
322      <ul>
323        <li>It updates a <samp>&lt;repos&gt;.latest</samp> file with the latest
324        revision number.</li>
325
326        <li>It creates a dump of the new revision.</li>
327
328        <li>It calls the script <code>background_updates.pl</code> if it
329        exists.</li>
330      </ul>This script is installed as standard in all our repositories.
331    </dd>
332
333    <dt>templates/hooks/background_updates.pl</dt>
334
335    <dd>An example of how you may want to set up a
336    <code>background_updates.pl</code> script to perform post-commit tasks for
337    a specific repository. This script uses a lock file to prevent multiple
338    commits in quick succession from causing problems.</dd>
339
340    <dt>templates/hooks/pre-revprop-change</dt>
341
342    <dd>A simple pre-revprop-change hook script which runs the script
343    <code>pre-revprop-change.pl</code>.</dd>
344
345    <dt>templates/hooks/pre-revprop-change.pl</dt>
346
347    <dd>If a user attempts to modify the log message of a changeset and he/she
348    is not the original author of the changeset, this script will e-mail the
349    original author. You can also set up a watch facility to monitor changes of
350    log messages that affect particular paths in the repository. For further
351    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.</dd>
354
355    <dt>templates/hooks/post-revprop-change</dt>
356
357    <dd>A simple post-revprop-change hook script which invokes the
358    <code>trac-admin</code> command to <code>resync</code> the revision
359    property cache stored in the corresponding Trac environment.</dd>
360
361    <dt>templates/utils/cron_template.sh</dt>
362
363    <dd>An example of how you might set up a cron job to make use of the
364    <samp>&lt;repos&gt;.latest</samp> file.</dd>
365
366    <dt>templates/utils/FCM/Admin/</dt>
367
368    <dd>A Perl library in the <code>FCM::Admin::*</code> name space, which
369    implements the functionalities of the FCM admin utility commands.</dd>
370
371    <dt>templates/utils/fcm-*</dt>
372
373    <dd>A selection of useful FCM admin utility commands.</dd>
374  </dl>
375
376  </div>
377  </div>
378  </div>
379
380  <hr/>
381  <div class="container-fluid text-center">
382    <div class="row"><div class="col-md-12">
383    <address><small>
384      Copyright &copy; 2006-2021 British Crown (Met Office) &amp; Contributors.
385      <a href="http://www.metoffice.gov.uk">Met Office</a>.
386      See <a href="../etc/fcm-terms-of-use.html">Terms of Use</a>.<br />
387      This document is released under the British <a href=
388      "http://www.nationalarchives.gov.uk/doc/open-government-licence/" rel=
389      "license">Open Government Licence</a>.<br />
390    </small></address>
391    </div></div>
392  </div>
393
394  <script type="text/javascript" src="../etc/jquery.min.js"></script>
395  <script type="text/javascript" src="../etc/bootstrap/js/bootstrap.min.js"></script>
396  <script type="text/javascript" src="../etc/fcm.js"></script>
397  <script type="text/javascript" src="../etc/fcm-version.js"></script>
398</body>
399</html>
Note: See TracBrowser for help on using the repository browser.