diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 1999-06-04 01:30:13 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 1999-06-04 01:30:13 +0000 |
commit | 67797a0990e5f662d6d5a45d57b8df9621d9b446 (patch) | |
tree | d4f372c14f4e8c1daa17a45d570dc51ad209fa3b /lib/libc/gen/dirname.3 | |
parent | bed33d97a346af66478a7c10a123af07e1608056 (diff) |
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).
Diffstat (limited to 'lib/libc/gen/dirname.3')
-rw-r--r-- | lib/libc/gen/dirname.3 | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/lib/libc/gen/dirname.3 b/lib/libc/gen/dirname.3 index 0ad1174d499..05d57025dff 100644 --- a/lib/libc/gen/dirname.3 +++ b/lib/libc/gen/dirname.3 @@ -24,7 +24,7 @@ .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: dirname.3,v 1.6 1999/05/29 16:08:54 aaron Exp $ +.\" $OpenBSD: dirname.3,v 1.7 1999/06/04 01:30:10 aaron Exp $ .\" .Dd August 17, 1997 .Dt DIRNAME 3 @@ -49,9 +49,7 @@ Any trailing characters are not counted as part of the directory name. If .Ar path -is a -.Dv NULL -pointer, the empty string, or contains no +is a null pointer, the empty string, or contains no .Sq \&/ characters, .Fn dirname @@ -66,9 +64,7 @@ returns a pointer to the parent directory of .Pp If .Fn dirname -fails, a -.Dv NULL -pointer is returned and the global variable +fails, a null pointer is returned and the global variable .Va errno is set to indicate the error. .Sh ERRORS |