summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorjmg <jmg@FreeBSD.org>2015-06-30 19:06:14 +0000
committerjmg <jmg@FreeBSD.org>2015-06-30 19:06:14 +0000
commit340fd3591ac9bab159284d82555e3e850072ab20 (patch)
treec0f267d2a557f28b44dd867e255084791d8898e9 /share
parent03c73d6a38adbcbeafa91923e96459aefb6188e8 (diff)
downloadFreeBSD-src-340fd3591ac9bab159284d82555e3e850072ab20.zip
FreeBSD-src-340fd3591ac9bab159284d82555e3e850072ab20.tar.gz
add units to the length and count so that it's clear what they
are measured in... Gems like: "len is the length of the buffer." aren't useful in man pages.
Diffstat (limited to 'share')
-rw-r--r--share/man/man9/hash.911
1 files changed, 9 insertions, 2 deletions
diff --git a/share/man/man9/hash.9 b/share/man/man9/hash.9
index 961be0b5..3276fd1 100644
--- a/share/man/man9/hash.9
+++ b/share/man/man9/hash.9
@@ -26,7 +26,7 @@
.\" $OpenBSD: hash.9,v 1.5 2003/04/17 05:08:39 jmc Exp $
.\" $FreeBSD$
.\"
-.Dd October 18, 2014
+.Dd June 30, 2015
.Dt HASH 9
.Os
.Sh NAME
@@ -72,6 +72,13 @@ These functions can be used to hash
.Dv NUL
terminated strings, as well as blocks of memory.
.Pp
+A
+.Fa len
+argument is the length of the buffer in bytes.
+A
+.Fa count
+argument is the length of the buffer in 32-bit words.
+.Pp
The
.Fn hash32_buf
function is used as a general buffer hashing function.
@@ -79,7 +86,7 @@ The argument
.Fa buf
is used to pass in the location, and
.Fa len
-is the length of the buffer.
+is the length of the buffer in bytes.
The argument
.Fa hash
is used to extend an existing hash, or is passed the initial value
OpenPOWER on IntegriCloud