[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

CVS: cvs.openbsd.org: src

Module name:	src
Changes by:	aaron_(_at_)_cvs_(_dot_)_openbsd_(_dot_)_org	1999/06/03 19:30:12

Modified files:
	lib/libc/gen   : basename.3 confstr.3 ctermid.3 directory.3 
	                 dirname.3 exec.3 fts.3 getbsize.3 getcap.3 
	                 getcwd.3 getdomainname.3 getfsent.3 getgrent.3 
	                 gethostname.3 getpass.3 getpwent.3 getttyent.3 
	                 getusershell.3 glob.3 popen.3 psignal.3 
	                 pwcache.3 sysctl.3 time.3 ttyname.3 uname.3 
	                 utime.3 valloc.3 vis.3 

Log message:
After some constructive criticism from pjanzen@ and some e-mail tag:

- only use the .Dv NULL form when referring explicitly to a function
argument or return value
- otherwise, use these forms:
o non-null
o null-terminated (hyphenated form for predicate adjective)
o else, null terminated, or null terminate, whichever the case
o null pointer, null byte, null string, etc.
- may use NUL to refer to an ASCII NUL, but it doesn't need a .Tn macro

In general, capitalizing the word "null" everywhere is unnecessary and makes
the man pages harder to read. The above is consistent with popular programming
texts (i.e., K&R, Stevens).