summaryrefslogtreecommitdiff
path: root/lib/libc/gen/getbsize.3
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>1999-06-04 01:30:13 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>1999-06-04 01:30:13 +0000
commit67797a0990e5f662d6d5a45d57b8df9621d9b446 (patch)
treed4f372c14f4e8c1daa17a45d570dc51ad209fa3b /lib/libc/gen/getbsize.3
parentbed33d97a346af66478a7c10a123af07e1608056 (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/getbsize.3')
-rw-r--r--lib/libc/gen/getbsize.37
1 files changed, 3 insertions, 4 deletions
diff --git a/lib/libc/gen/getbsize.3 b/lib/libc/gen/getbsize.3
index 330b908fb2f..998f129a419 100644
--- a/lib/libc/gen/getbsize.3
+++ b/lib/libc/gen/getbsize.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: getbsize.3,v 1.5 1999/05/29 22:38:34 aaron Exp $
+.\" $OpenBSD: getbsize.3,v 1.6 1999/06/04 01:30:10 aaron Exp $
.\"
.\" Copyright (c) 1993
.\" The Regents of the University of California. All rights reserved.
@@ -52,15 +52,14 @@ for details on its use and format.
.Pp
The
.Fn getbsize
-function returns a pointer to a NUL-terminated
+function returns a pointer to a null-terminated
string describing
the block size, something like
.Qq 1K-blocks .
The memory referenced by
.Fa headerlenp
is filled in with the length of the string (not including the
-terminating
-.Dv NULL ) .
+terminating null byte).
The memory referenced by
.Fa blocksizep
is filled in with the block size, in bytes.