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

[Poul-Henning Kamp]

In message <200501051521.08617.jhb at FreeBSD.org>, John Baldwin writes:
>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.

That's not really a big problem since the copyright should always be the
first comment in the file.

A harder problem is to detect when the copyright ends.

It could be an idea to add a convention for explicitly marking the
start and end of "file restrictions" but then again it could also
be wast overkill.

-- 
Poul-Henning Kamp       | UNIX since Zilog Zeus 3.20
phk at FreeBSD.ORG         | TCP/IP since RFC 956
FreeBSD committer       | BSD since 4.3-tahoe    
Never attribute to malice what can adequately be explained by incompetence.