Re: [oc] Conventions Updated (18feb)

["Damjan Lampret" <lampret@opencores.org>]

> Example Revision List
> --------------------------------------------------------------------------
-----------------
> -- Revision Number : 1
> -- Date of Change : 20th March 2000
> -- Modifier : Harish Y S (harish@opencores.org)
> -- Description : Initial Design

There can be also automatically CVS generated revision list. You can embedd
different CVS keywords and construct different revision lists. This could
simplify things. For example you can add $Log$ keyword and it will be
expanded by CVS in something like this:

-- $Log: test.vhd,v $
-- Revision 1.2  2000/02/18 14:43:14  lampret
-- Changed entity name.
--
-- Revision 1.1  2000/02/18 14:42:31  lampret
-- Initial import to CVS.
--

A short list of keywords from CVS manual:
`$Author$'
     The login name of the user who checked in the revision.

`$Date$'
     The date and time (UTC) the revision was checked in.

`$Header$'
     A standard header containing the full pathname of the RCS file,
     the revision number, the date (UTC), the author, the state, and
     the locker (if locked).  Files will normally never be locked when
     you use CVS.

`$Id$'
     Same as `$Header$', except that the RCS filename is without a path.

`$Name$'
     Tag name used to check out this file.  The keyword is expanded
     only if one checks out with an explicit tag name.  For example,
     when running the command `cvs co -r first', the keyword expands to
     `Name: first'.

`$Locker$'
     The login name of the user who locked the revision (empty if not
     locked, which is the normal case unless `cvs admin -l' is in use).

`$Log$'
     The log message supplied during commit, preceded by a header
     containing the RCS filename, the revision number, the author, and
     the date (UTC).  Existing log messages are _not_ replaced.
     Instead, the new log message is inserted after `$Log:...$'.  Each
     new line is prefixed with the same string which precedes the
     `$Log' keyword.  For example, if the file contains

            /* Here is what people have been up to:
             *
             * $Log: frob.c,v $
             * Revision 1.1  1997/01/03 14:23:51  joe
             * Add the superfrobnicate option
             *
             */
`$RCSfile$'
     The name of the RCS file without a path.

`$Revision$'
     The revision number assigned to the revision.

`$Source$'
     The full pathname of the RCS file.

`$State$'
     The state assigned to the revision.  States can be assigned with
     `cvs admin -s'

regards, Damjan



     then additional lines which are added when expanding the `$Log'
     keyword will be preceded by `   * '.  Unlike previous versions of
     CVS and RCS, the "comment leader" from the RCS file is not used.
     The `$Log' keyword is useful for accumulating a complete change
     log in a source file, but for several reasons it can be
     problematic.