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/ttyname.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/ttyname.3')
-rw-r--r-- | lib/libc/gen/ttyname.3 | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/lib/libc/gen/ttyname.3 b/lib/libc/gen/ttyname.3 index b2e804b6aa4..706ec728153 100644 --- a/lib/libc/gen/ttyname.3 +++ b/lib/libc/gen/ttyname.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ttyname.3,v 1.7 1999/05/29 22:38:36 aaron Exp $ +.\" $OpenBSD: ttyname.3,v 1.8 1999/06/04 01:30:11 aaron Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -84,7 +84,7 @@ a file descriptor for which is true. The .Fn ttyname_r -function stores the NUL-terminated +function stores the null-terminated pathname of the terminal associated with the file descriptor .Fa fd @@ -107,13 +107,11 @@ The .Fn ttyname and .Fn ttyname_r -functions return the NUL-terminated +functions return the null-terminated name if the device is found and .Fn isatty is true; otherwise -a -.Dv NULL -pointer is returned and +a null pointer is returned and .Dv errno is set to indicate the error. .Pp @@ -149,7 +147,7 @@ argument does not refer to a terminal device. The value of .Fa namesize is smaller than the length of the string to be returned including the -terminating nul character. +terminating NUL character. .El .Sh FILES .Bl -tag -width /etc/ttys -compact |