svn commit: r186187 - head/sys/net
brde at optusnet.com.au
Wed Dec 17 14:29:52 UTC 2008
On Wed, 17 Dec 2008, Robert Watson wrote:
> On Wed, 17 Dec 2008, Dag-Erling SmÃ¸rgrav wrote:
>> Robert Watson <rwatson at FreeBSD.org> writes:
>>> exit(EX_OK); /*
>>> * Avoid obvious comments such as
>>> * "Exit 0 on success."
>> Umm, didn't we agree *not* to use sysexits?
> Dunno, that one is not mine:
> Annotations for style.9
> 1.5 (joerg 31-Mar-96): exit(EX_OK); /*
> 1.38 (alex 28-Oct-00): exit(EX_USAGE);
1.5 is the original commit that added sysexits to style.9.
It also broke the comment -- it is no longer obvious that exit(EX_OK)
exits with status 0 on success.
Also, reformatting the comment gave the bad example of a block comment
to the right of the code. The original code instead gave an example
of abnormally indenting the comment so as to fit it in 80 columns:
exit(0); /* Avoid obvious comments such as "Exit 0 on success." */
The comment is indented to column 20 instead of the usual 40 or 32.
The reformatting is part of another bug suite -- to coerce
/usr/src/admin/style/style into a man page, 5 leading spaces had to
be added for man page indentation. This required reformatting to keep
fitting in 80 columns and messes up tabs.
More information about the svn-src-all