[Mitgcm-support] CVS keywords

[mitgcm-support at dev.mitgcm.org]

I've noticed that not all our files have CVS/RCS keywords  in them;
most are newly created files (some are mine). There are also files
using different keywords to most.

The difference between $Header$ and $Id$ is:
    $Header: /u/gcmpack/development/adcroft/atmos/model/src/ini_fields.F,v
1.2.2.2 2000/12/01 14:32:20 adcroft Exp $
    $Id: ini_fields.F,v 1.2.2.2 2000/12/01 14:32:20 adcroft Exp $
The latter is more succinct but since we have multiple copies
of files in the repository (ie. the ocean version, the 3
atmospheric versions, personal versions) we couldn't easily
tell where the file came from using $Id$.

There's a nice keyword that I wasn't previously aware of
that we sould probably use, $Name$. When you checkout/export
a file using a tag, $Name$ expands to the tag. That means
when we ship out a checkpoint, the files would have
  $Name: checkpoint33-beta$    (for example)

There's also another keyword that seems really useful, $Log$.
Every time you commit and write comments, those comments
are inserted at the $Log$ entry. e.g.

C $Header: /u/gcmpack/development/adcroft/atmos/model/src/ini_fields.F,v 1.2.2.3
2000/12/01 15:23:41 adcroft Exp $
C $Name: cube-3d-linear-tested$
C
C $Log: ini_fields.F,v $
C Revision 1.2.2.3  2000/12/01 15:23:41  adcroft
C Trying new CVS keyword header
C
C Revision 1.2.2.2  2000/12/01 13:55:40  adcroft
C Experimenting with CVS keywords
C
C Revision 1.2 2000/11/28 11:34:25  jmc
C Added initialization from file for free-surface
C displacement.

However, there's a catch with $Log$ which is that merging files
between different versions/branches treats te $Log$ entries as
source modifications and the automatic merge oftern deletes some
of the comments. I'd like to use it but it may cause us more work...

How about adding $Name$? I suggest either
 C $Header$ $Name$
or
 C $Header$
 C $Name$
and always as the first line(s) of the file (and not at the bottom).

Alistair.