cvs commit: src/share/examples/ses/getencstat getencstat.0
src/share/examples/ses/setobjstat setobjstat.0 src/shar
ru at FreeBSD.org
Thu Feb 10 14:59:06 GMT 2005
On Thu, Feb 10, 2005 at 09:06:51PM +1100, Bruce Evans wrote:
> On Thu, 10 Feb 2005, Ruslan Ermilov wrote:
> > On Thu, Feb 10, 2005 at 03:02:49PM +1100, Bruce Evans wrote:
> > > On Wed, 9 Feb 2005, Ceri Davies wrote:
> > > > style(9) doesn't say anything about this - could you add something
> > > > please?
> > >
> > It actually does. Manpages are similar to C header files in this
> > respect, i.e., the following apply, among other:
> > - after a copyright header, there's a blank line, and then $FreeBSD$;
> It literally says "rcsid" instead of "$FreeBSD$" here, and only mentions
> $FreeBSD$ by example. I avoid using "rcsid" since ids may or may not be
I take it differently. I'm pretty sure that by "rcsid" only $FreeBSD$
is meant, while "sccsid" falls under "obtained from elsewhere", and as
such "should not be edited".
At the time of rev. 1.48 of style.9 where "rcsid" was added,
the example following it looked like this:
static const char rcsid =
So it's a clear leftover from when we later switched from "rcsid" to
__FBSDID(). I suggest that we say "$FreeBSD$" not __FBSDID in a
manpage, so it's applicable both to C source files and other source
files, including manpages:
RCS file: /home/ncvs/src/share/man/man9/style.9,v
retrieving revision 1.117
diff -u -r1.117 style.9
--- style.9 9 Feb 2005 18:07:17 -0000 1.117
+++ style.9 10 Feb 2005 13:05:28 -0000
@@ -23,9 +23,10 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
+.\" From: @(#)style 1.14 (Berkeley) 4/28/95
.\" $FreeBSD: src/share/man/man9/style.9,v 1.117 2005/02/09 18:07:17 ru Exp $
-.Dd December 7, 2001
+.Dd February 10, 2005
.Dt STYLE 9
@@ -82,7 +83,7 @@
considered license statements.
After any copyright header, there is a blank line, and the
for source files.
Version control system ID tags should only exist once in a file
(unlike in this one).
> > - $FreeBSD$ should exist only once, except in the style.9 manpage;
> It actually says "Version control system ID tags" instead of "$FreeBSD$"
> here. This covers $FreeBSD$ with more than an example, but without the
> example it only requires at most 1 $FreeBSD$ and not exactly 1.
It's fine -- our CVS won't let it in if it doesn't have any. ;)
> > - keep and do not edit foreign IDs.
> > > style.9 says a lot about this for C programs, and used to say something
> > > about this for man pages by example: $FreeBSD$ goes immediately after
> > > the vendor id.
> > >
> > Except it actually says to put $FreeBSD$ after a copyright block, and
> Except is actually says that there is an rcsid after the copyright block,
> and then gives an example with an sccsid instead of an rcsid. Only the
> example shows that other ids follow the "rcsid".
See above about rcsid vs. __FBSDID().
ru at FreeBSD.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Size: 187 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/cvs-all/attachments/20050210/5c0a13c5/attachment-0001.bin
More information about the cvs-all