/usr/share/doc/fcm/release_notes/2-1.html is in fcm 2016.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 | <!DOCTYPE html>
<html>
<head>
<title>FCM 2-1 Release Notes</title>
<meta name="author" content="FCM team" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="../etc/fcm-icon.png" type="image/png" />
<link rel="shortcut icon" href="../etc/fcm-icon.png" type="image/png" />
<link href="../etc/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen" />
<link href="../etc/fcm.css" rel="stylesheet" media="screen" />
</head>
<body>
<div class="navbar navbar-inverse">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href=".."><span class="fcm-version">FCM</span></a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="../installation/">Installation</a></li>
<li><a href="../user_guide/">User Guide</a></li>
</ul>
</div>
</div>
</div>
<div class="page-header">
<div class="fcm-page-content pull-right well well-sm"></div>
<h1>FCM 2-1 Release Notes <small>22 July 2011</small></h1>
</div>
<div class="container">
<div class="row">
<div class="col-md-12">
<p>These are the release notes for FCM 2-1. You can use this release of FCM
freely under the terms of the FCM LICENSE, which you should receive with the
distribution of this release.</p>
<p>FCM is maintained by the FCM team at the Met Office. Please feedback any
bug reports or feature requests to us by <a href=
"mailto:fcm-team@metoffice.gov.uk">e-mail</a>.</p>
<h2 id="new">What's New?</h2>
<p>No major new features in this release.</p>
<h2 id="fix">Minor Changes and Bug Fixes</h2>
<dl>
<dt><code>fcm branch-create</code></dt>
<dd>
<p>if the <code>--ticket=N</code> option is not specified and
<var>NAME</var> contains only a list of positive integers separated by
<code>[_-]</code> (an underscore or a hyphen), the command will now assume
that <var>NAME</var> also specifies the related ticket numbers.</p>
<p>ticket numbers will now prefix the 1st line of the automatic commit log
message.</p>
</dd>
<dt><code>fcm cmp-ext-cfg</code></dt>
<dd>
<p>fixed <code>--wiki-format=TARGET</code> option, broken at <a href=
"2-0.html">2-0</a>.</p>
</dd>
<dt><code>fcm export-items</code></dt>
<dd>
<p>fixed <code>--new</code> option, broken at <a href=
"2-0.html">2-0</a>.</p>
<p>now generate real <samp>v*</samp> directories and revision directories
as symbolic links.</p>
<p><code>fcm_update_version_dir.pl</code> removed.</p>
</dd>
<dt><code>fcm make</code></dt>
<dd>
<p>build: allow space between <code>#</code> and <code>include</code> for
<code>#include</code> syntax in C or Fortran source files requiring
pre-processing.</p>
<p>build: will now fail when an invalid target key is specified.</p>
<p>build: correctly support compilers and linkers that require a space
between an option flag and its argument.</p>
<p>build: will no longer call <code>ar</code> for single file link.</p>
<p>build: improve error message if a target does not exist in the expected
location following an update.</p>
<p>build: <code>target-rename</code> declarations are now non-cumulative,
as documented.</p>
<p>build: <code>build.prop{file-name-option.f90-mod} = case=upper</code>
can now be specified for compilers that generate <samp>MODULE.mod</samp>
files for Fortran modules (as opposed to the more common
<samp>module.mod</samp> convention).</p>
<p>extract: <code>path-incl</code>, <code>path-excl</code>,
<code>path-root</code> declarations no longer require a name-space.</p>
<p>extract: fixed error handling when multiple processing.</p>
</dd>
<dt><code>fcm mkpatch</code></dt>
<dd>
<p>fixed CLI prompt to confirm removal of old output directory.</p>
<p>ensure initial branch creation is ignored.</p>
</dd>
<dt>commit message text editor</dt>
<dd>
<p><code>fcm branch-create</code>, <code>fcm
branch-delete</code> and <code>fcm commit</code> now support the
<var>[helpers] editor-cmd</var> option defined in
<samp>$HOME/.subversion/config</samp>.</p>
<p><code>nedit</code> is no longer the default external text editor.
<code>vi</code> is the default external text editor for the command line
interface. <code>gedit</code> is the default external text editor for
<code>fcm gui</code>.</p>
</dd>
<dt>configuration file syntax</dt>
<dd>
<p>the <code>inc=LOCATION</code> is no longer supported for configuration
files in the new part of the system.</p>
<p>incorrect variable assignment syntax will now trigger an exception.</p>
<p>leading and trailing spaces in modifiers and name-space are now
ignored without triggering Perl warnings.</p>
</dd>
<dt>installation dependency</dt>
<dd>
<p><code>fcm</code> no longer requires the <code>XML::DOM</code> Perl
module. It now uses <code>XML::Parser</code> instead. The latter is
normally installed by default on most Unix/Linux platforms.</p>
</dd>
</dl>
<h2 id="issues">Known Issues</h2>
<dl>
<dt>Build inheritance limitation: handling of include files</dt>
<dd>See the <a href="../user_guide/make.html#build.inherit">User Guide >
FCM Make > Build > Build Inheritance</a> for detail.</dd>
</dl>
<h2 id="req">System Requirements</h2>
<h3 id="req.perl">Perl</h3>
<p>The core part of FCM is a set of Perl scripts and modules. At the Met
Office, FCM runs on:</p>
<dl>
<dt>Perl 5.8.2 on AIX 5.3</dt>
<dd>
<p><code>Text::ParseWords</code> (core Perl module) is upgraded to
version 3.22.</p>
<p>Met Office users do not use the code management commands and the
extract system on this platform.</p>
</dd>
<dt>Perl 5.8.5 on RHEL 4</dt>
<dd>
<p><a href=
"http://search.cpan.org/~gaas/libwww-perl/lib/HTTP/Date.pm">HTTP::Date</a>
in <a href="http://search.cpan.org/~gaas/libwww-perl/">libwww-perl</a> is
required by <code>fcm extract</code> and the extract system in <code>fcm
make</code>. (libwww-perl 5.79 installed.)</p>
<p><a href="http://search.cpan.org/dist/XML-Parser/">XML::Parser</a> is
required by the code management commands. (2.34 installed.)</p>
<p><a href="http://search.cpan.org/~srezic/Tk/">Tk</a> is required by the
<code>fcm gui</code> command. (Tk 804.027 installed.)</p>
</dd>
</dl>
<h3 id="req.svn">Subversion</h3>
<p>To use the code management commands (and relevant parts of the extract
system) you need to have <a href=
"http://subversion.tigris.org/">Subversion</a> installed.</p>
<p>FCM requires Subversion 1.4.x or above. At the Met Office we are currently
using Subversion 1.4.3.</p>
<p>Note: you can use the extract system to mirror code to a remote platform
for building. Therefore it is only necessary to have Subversion installed on
the platform where you do your code development. If you use other platforms
purely for building and running then you do not need to have Subversion
installed on these platforms.</p>
<h3 id="req.trac">Trac</h3>
<p>The use of <a href="http://trac.edgewall.org/">Trac</a> is entirely
optional (although highly recommended if you are using Subversion).</p>
<p>At the Met Office we are currently using Trac 0.11.7. Note:</p>
<ul>
<li>The <code>--trac</code> and <code>--wiki</code> options to the
<code>fcm diff --branch</code> command allow you to view branch differences
using Trac. This requires Trac 0.10 or above.</li>
<li>Some of the example scripts in the <samp>examples/</samp> directory
require Trac 0.11.</li>
</ul>
<h3 id="req.other">Other Requirements</h3>
<p>The <code>fcm conflicts</code> command requires <a href=
"http://furius.ca/xxdiff/">xxdiff</a>. At the Met Office we are currently
using version 3.1. The <code>fcm diff --graphical</code> command also uses
xxdiff by default although other graphical diff tools can also be used.</p>
<p>The <code>fcm make</code> command uses <code>gzip</code>. At the Met
Office we are currently using gzip 1.2.4 on AIX 5.3 and gzip 1.3.3 on RHEL
4.</p>
<p>The extract system uses <code>diff3</code>, (which is part of <a href=
"http://www.gnu.org/software/diffutils/">GNU diffutils</a>), to merge
together changes where the same file is modified by two different branches
(compared with the base branch). At the Met Office we are currently using
version 2.8.1.</p>
<p>The mirror system uses <a href="http://rsync.samba.org/">rsync</a> to
mirror source file to another machine. At the Met Office we are currently
using version 2.6.3</p>
<p>The deprecated <code>fcm build</code> requires <a href=
"http://www.gnu.org/software/make/make.html">GNU make</a>. At the Met Office
we are currently using version 3.80.</p>
<p>FCM is intended to run on a Unix/Linux system. It is currently used at the
Met Office on Linux (RHEL 4.8) and AIX 5.3.</p>
<h2 id="ins">Installation</h2>
<p>FCM is distributed in the form of a compressed tar file. Un-pack the tar
file into an appropriate location on your system. Add the <samp>bin/</samp>
directory into your <var>PATH</var> environment variable. Once you have done
this you should now have full access to the FCM system, assuming that you
have met the requirements described in the previous section.</p>
<p>You should find the following contents in the distribution:</p>
<dl>
<dt>README</dt>
<dd>The README file contains the internal revision number of the
release.</dd>
<dt>COPYRIGHT.txt<br />
LICENSE.html</dt>
<dd>The FCM license and other copyright information.</dd>
<dt>bin/</dt>
<dd>Contains the <code>fcm</code> command and other utilities.</dd>
<dt>doc/</dt>
<dd>System documentation.</dd>
<dt>doc/release_notes/</dt>
<dd>Contains these release notes. It also contains the release notes for
all previous versions which may be useful if you have skipped any
versions.</dd>
<dt>doc/user_guide/</dt>
<dd>Contains the <a href="../user_guide/">FCM User Guide</a>.</dd>
<dt>doc/standards/</dt>
<dd>Contains the FCM <a href="../standards/perl_standard.html">Perl</a> and
<a href="../standards/fortran_standard.html">Fortran</a> coding standards.
The Perl standard describes the standards followed by the FCM code. The
Fortran standard contains some <a href=
"../standards/fortran_standard.html#fcm">specific advice</a> on the best
way of writing Fortran code for use with FCM as well as more general advice
on good practice.</dd>
<dt>doc/collaboration/</dt>
<dd>Contains the <a href="../collaboration/index.html">External
Distribution & Collaboration for FCM Projects</a> document which
discusses how projects configured under FCM can be distributed
externally.</dd>
<dt>etc/</dt>
<dd>Miscellaneous items, including the <samp>fcm/keyword.cfg.eg</samp> file.
If you wish to define keywords for your site you will need to create the
<samp>etc/fcm/keyword.cfg</samp> file. An example file,
<samp>fcm/keyword.cfg.eg</samp>, is provided which is a copy of the file
currently used at the Met Office. For further details please refer to the
section <a href="../user_guide/system_admin.html#fcm-keywords">FCM
keywords</a> in the System Admin chapter of the User Guide.</dd>
<dt>examples/</dt>
<dd>Contains various example scripts which you may find useful. Note that
these scripts are all specific to the Met Office and may contain hard coded
paths and email addresses. They are provided in the hope that you may find
them useful as examples for setting up similar scripts of your own.
However, they should only be used after careful review to adapt them to
your environment.</dd>
<dt>examples/etc/regular-update.eg</dt>
<dd>An example of how you might set up a cron job to make use of the
<samp><repos>.latest</samp> file (see
<code>examples/svn-hooks/post-commit-background</code>).</dd>
<dt>examples/lib/</dt>
<dd>Contains the <code>FCM::Admin::*</code> Perl library, which implements
the functionalities of the FCM admin utility commands.</dd>
<dt>examples/sbin/</dt>
<dd>Contains a selection of useful admin utility commands.</dd>
<dt>examples/svn-hooks/pre-commit</dt>
<dd>
This script restricts write-access to the repository by checking the
following:
<ul>
<li>It executes the Subversion utility <code>svnperms.py</code> if it,
and the associated <samp>svnperms.conf</samp> file, exist. This utility
checks whether the author of the current transaction has enough
permission to write to particular paths in the repository.</li>
<li>It checks the disk space required by the current transaction. It
fails the commit if it requires more than 5Mb of disk space.</li>
</ul>
</dd>
<dt>examples/svn-hooks/post-commit</dt>
<dd>A simple post-commit hook script which runs the script
<code>post-commit-background</code> in the background.</dd>
<dt>examples/svn-hooks/post-commit-background</dt>
<dd>
This script runs in the background after each commit.
<ul>
<li>It updates a <samp><repos>.latest</samp> file with the latest
revision number.</li>
<li>It creates a dump of the new revision.</li>
<li>It calls <code>post-commit-background-custom</code> if it
exists.</li>
</ul>
</dd>
<dt>examples/svn-hooks/pre-revprop-change</dt>
<dd>A simple pre-revprop-change hook script which runs the script
<code>pre-revprop-change.pl</code>.</dd>
<dt>examples/svn-hooks/pre-revprop-change.pl</dt>
<dd>If a user attempts to modify the log message of a changeset and he/she
is not the original author of the changeset, this script will e-mail the
original author. You can also set up a watch facility to monitor changes of
log messages that affect particular paths in the repository. For further
details please refer to the section <a href=
"../user_guide/system_admin.html#svn_watch">Watching changes in log
messages</a> in the System Admin chapter of the User Guide.</dd>
<dt>examples/svn-hooks/post-revprop-change</dt>
<dd>A simple post-revprop-change hook script which invokes the
<code>trac-admin</code> command to <code>resync</code> the revision
property cache stored in the corresponding Trac environment.</dd>
<dt>lib/</dt>
<dd>Contains the Perl library of FCM.</dd>
<dt>man/</dt>
<dd>Contains a basic manual page for <code>fcm</code>.</dd>
<dt>t/</dt>
<dd>Contains unit test for FCM.</dd>
<dt>test/</dt>
<dd>Contains regression tests for FCM.</dd>
<dt>test/test_include/</dt>
<dd>Contains simple test code to check how your chosen compilers handle
include files (see <a href="#issues">Known Issues</a>).</dd>
<dt>tutorial/</dt>
<dd>Contains the files necessary to set up a Subversion repository for the
FCM tutorial. This will allow you to follow the <a href=
"../user_guide/getting_started.html#tutorial">tutorial section</a> in the
User Guide. See <samp>tutorial/README</samp> on how to set it up.</dd>
</dl>
</div>
</div>
</div>
<hr/>
<div class="container-fluid text-center">
<div class="row"><div class="col-md-12">
<address><small>
© British Crown Copyright 2006-16
<a href="http://www.metoffice.gov.uk">Met Office</a>.
See <a href="../etc/fcm-terms-of-use.html">Terms of Use</a>.<br />
This document is released under the British <a href=
"http://www.nationalarchives.gov.uk/doc/open-government-licence/" rel=
"license">Open Government Licence</a>.<br />
</small></address>
</div></div>
</div>
<script type="text/javascript" src="../etc/jquery.min.js"></script>
<script type="text/javascript" src="../etc/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../etc/fcm.js"></script>
<script type="text/javascript" src="../etc/fcm-version.js"></script>
</body>
</html>
|