Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 30 Jun 2015 19:06:14 +0000 (UTC)
From:      John-Mark Gurney <jmg@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r284967 - head/share/man/man9
Message-ID:  <201506301906.t5UJ6EDb066550@svn.freebsd.org>

index | next in thread | raw e-mail

Author: jmg
Date: Tue Jun 30 19:06:14 2015
New Revision: 284967
URL: https://svnweb.freebsd.org/changeset/base/284967

Log:
  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.

Modified:
  head/share/man/man9/hash.9

Modified: head/share/man/man9/hash.9
==============================================================================
--- head/share/man/man9/hash.9	Tue Jun 30 18:58:33 2015	(r284966)
+++ head/share/man/man9/hash.9	Tue Jun 30 19:06:14 2015	(r284967)
@@ -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


home | help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201506301906.t5UJ6EDb066550>