Remove the misleading description of the 'key' argument to

mpool_open(3) - it is *not* really used for synchronization; in fact,
it is not used at all.

PR:		70929
Submitted by:	Martin Kammerhofer <dada@sbox.tugraz.at>
MFC after:	3 days
This commit is contained in:
Peter Pentchev 2004-08-27 14:51:21 +00:00
parent dc26948b0c
commit 882bc79a39

View file

@ -65,32 +65,16 @@ The
.Nm mpool
library interface is intended to provide page oriented buffer management
of files.
The buffers may be shared between processes.
.Pp
The
.Fn mpool_open
function initializes a memory pool.
The
.Fa key
argument is the byte string used to negotiate between multiple
processes wishing to share buffers.
If the file buffers are mapped in shared memory, all processes using
the same key will share the buffers.
If
.Fa key
is
.Dv NULL ,
the buffers are mapped into private memory.
argument is currently ignored.
The
.Fa fd
argument is a file descriptor for the underlying file, which must be seekable.
If
.Fa key
is
.No non\- Ns Dv NULL
and matches a file already being mapped, the
.Fa fd
argument is ignored.
.Pp
The
.Fa pagesize