cvs commit: src/share/man/man9 style.9

Warner Losh imp at harmony.village.org
Wed Jan 5 13:15:27 PST 2005


> On Wednesday 05 January 2005 02:16 pm, Warner Losh wrote:
> > imp         2005-01-05 19:16:01 UTC
> >
> >   FreeBSD src repository
> >
> >   Modified files:
> >     share/man/man9       style.9
> >   Log:
> >   A large majority of the source files in the tree start their license
> >   and copyright statements in a comment that begins with /*-.  Document
> >   this tradition.  A strict adherence to this rule will help resellers
> >   that wish to publish all copyright notices, generated automatically
> >   from the tree.  There are too many variant licenses to do it purely
> >   by more complicated pattern matching.
> 
> I thought the reason for the - is that it prevented indent(1) from trying to 
> reindent that comment block and thus there might be comment blocks with a 
> leading '/*-' that aren't copyrights.

There might be, yes, and I've added a note to style(9) in my tree
explaining that.  In a quick straw poll of the source tree, I found no
comments starting in column 1 that weren't a license statement.
That's true that's what the /*- is for, but if any come to light, you
can change it to /** just as easily.

There are dozens in the tree that aren't in the first column, and
hundreds that should have it marked, but don't.  None of these are
affected by this slight change of convention.

Warner



More information about the cvs-src mailing list