source: XIOS/tools/FCM/doc/release_notes/1-2.html @ 1293

Last change on this file since 1293 was 81, checked in by ymipsl, 12 years ago

ajout FCM 1.5

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