docs/75995: hcreate(3) documentation(?) bug

[Ben Kaduk]

The following reply was made to PR docs/75995; it has been noted by GNATS.

From: "Ben Kaduk" <minimarmot at gmail.com>
To: bug-followup at FreeBSD.org
Cc:  
Subject: Re: docs/75995: hcreate(3) documentation(?) bug
Date: Wed, 2 Jul 2008 00:03:45 -0400

 It definitely looks like a documentation bug.
 
 I've put a patch up at
 http://stuff.mit.edu/afs/sipb.mit.edu/user/kaduk/freebsd/patches/htcreate.diff.2008.07.01
 in case gmail mangles the whitespace.
 
 Thanks to sbahra on #bsddocs for pointing out that we should mention that
 errno gets set.
 
 -Ben Kaduk
 
 --- hcreate.3.0 2008-07-01 23:29:00.000000000 -0400
 +++ hcreate.3   2008-07-01 23:53:17.000000000 -0400
 @@ -1,6 +1,6 @@
  .\" $FreeBSD: src/lib/libc/stdlib/hcreate.3,v 1.5 2005/01/20 09:17:04 ru Exp $
  .\"
 -.Dd May 8, 2001
 +.Dd July 1, 2008
  .Os
  .Dt HCREATE 3
  .Sh NAME
 @@ -23,6 +23,7 @@
  and
  .Fn hsearch
  functions manage hash search tables.
 +Only one hash table per process may be active at any given time.
  .Pp
  The
  .Fn hcreate
 @@ -111,7 +112,7 @@
  .Sh RETURN VALUES
  The
  .Fn hcreate
 -function returns 0 if it cannot allocate sufficient space for the table;
 +function returns 0 if the table creation failed;
  otherwise, it returns non-zero.
  .Pp
  The
 @@ -199,6 +200,8 @@
  .Bl -tag -width Er
  .It Bq Er ENOMEM
  Insufficient storage space is available.
 +.It Bq Er EINVAL
 +A table already exists.
  .El
  .Sh SEE ALSO
  .Xr bsearch 3 ,