diff options
| author |   aaron <aaron@openbsd.org> | 1999-06-04 01:30:10 +0000 |
|---|---|---|
| committer | aaron <aaron@openbsd.org> | 1999-06-04 01:30:10 +0000 |
| commit | 545403d5ba85af10b0396609ee9da69f3c14f513 (patch) | |
| tree | ad6766d92500c863cf65c7f48b2bb6e4eeccae9c /lib/libc/gen/basename.3 | |
| parent | start swapping on the first swap device after initialization (diff) | |
| download | wireguard-openbsd-545403d5ba85af10b0396609ee9da69f3c14f513.tar.xz wireguard-openbsd-545403d5ba85af10b0396609ee9da69f3c14f513.zip | |
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/basename.3')
| -rw-r--r-- | lib/libc/gen/basename.3 | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/lib/libc/gen/basename.3 b/lib/libc/gen/basename.3 index c712fed6613..53e01067660 100644 --- a/lib/libc/gen/basename.3 +++ b/lib/libc/gen/basename.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: basename.3,v 1.10 1999/05/29 16:08:54 aaron Exp $ +.\" $OpenBSD: basename.3,v 1.11 1999/06/04 01:30:10 aaron Exp $ .\" .Dd August 17, 1997 .Dt BASENAME 3 @@ -52,9 +52,7 @@ characters, a pointer to the string .Qq \&/ is returned. If .Ar path -is a -.Dv NULL -pointer or the empty string, a pointer to the string +is a null pointer or the empty string, a pointer to the string .Qq \&. is returned. .Sh RETURN VALUES @@ -65,9 +63,7 @@ returns a pointer to the last component of .Pp If .Fn basename -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 |