svn commit: r205240 - user/lstewart/alq_varlen_head/share/man/man9

[Lawrence Stewart]

Author: lstewart
Date: Wed Mar 17 05:59:21 2010
New Revision: 205240
URL: http://svn.freebsd.org/changeset/base/205240

Log:
  Update man page in light of changes in previous commit.
  
  Sponsored by:	FreeBSD Foundation

Modified:
  user/lstewart/alq_varlen_head/share/man/man9/alq.9

Modified: user/lstewart/alq_varlen_head/share/man/man9/alq.9
==============================================================================
--- user/lstewart/alq_varlen_head/share/man/man9/alq.9	Wed Mar 17 05:54:46 2010	(r205239)
+++ user/lstewart/alq_varlen_head/share/man/man9/alq.9	Wed Mar 17 05:59:21 2010	(r205240)
@@ -37,6 +37,7 @@
 .Sh NAME
 .Nm alq ,
 .Nm alq_open ,
+.Nm alq_open_flags ,
 .Nm alq_write ,
 .Nm alq_writen ,
 .Nm alq_flush ,
@@ -44,7 +45,7 @@
 .Nm alq_get ,
 .Nm alq_getn ,
 .Nm alq_post ,
-.Nm alq_postn
+.Nm alq_post_flags
 .Nd Asynchronous Logging Queues
 .Sh SYNOPSIS
 .In sys/alq.h
@@ -58,6 +59,16 @@
 .Fa "int count"
 .Fc
 .Ft int
+.Fo alq_open_flags
+.Fa "struct alq **app"
+.Fa "const char *file"
+.Fa "struct ucred *cred"
+.Fa "int cmode"
+.Fa "int size"
+.Fa "int count"
+.Fa "int flags"
+.Fc
+.Ft int
 .Fn alq_write "struct alq *alq" "void *data" "int flags"
 .Ft int
 .Fn alq_writen "struct alq *alq" "void *data" "int len" "int flags"
@@ -72,7 +83,7 @@
 .Ft void
 .Fn alq_post "struct alq *alq" "struct ale *ale"
 .Ft void
-.Fn alq_postn "struct alq *alq" "struct ale *ale" "int flags"
+.Fn alq_post_flags "struct alq *alq" "struct ale *ale" "int flags"
 .Sh DESCRIPTION
 The
 .Nm
@@ -121,7 +132,7 @@ each of fixed size (set at queue creatio
 Fixed length mode is deprecated in favour of variable length mode.
 .Sh FUNCTIONS
 The
-.Fn alq_open
+.Fn alq_open_flags
 function creates a new asynchronous logging queue.
 The
 .Fa file
@@ -159,6 +170,20 @@ argument should be set to the number of
 byte chunks to reserve capacity for.
 .Pp
 The
+.Fn alq_open
+function is implemented as a wrapper around
+.Fn alq_open_flags
+to provide backwards compatibility to consumers that have not been updated to
+utilise the newer
+.Fn alq_open_flags
+function.
+It simply passes all arguments through to
+.Fn alq_open_flags
+untouched, and sets
+.Fa flags
+to 0.
+.Pp
+The
 .Fn alq_writen
 function writes
 .Fa len
@@ -235,7 +260,7 @@ This function leaves
 in a locked state, until a subsequent
 .Fn alq_post
 or
-.Fn alq_postn
+.Fn alq_post_flags
 call is made.
 If
 .Fn alq_getn
@@ -274,7 +299,7 @@ Note that it is an error to call
 on a variable length mode queue.
 .Pp
 The
-.Fn alq_postn
+.Fn alq_post_flags
 function schedules the asynchronous log entry
 .Fa ale
 (obtained from
@@ -294,17 +319,13 @@ in an unlocked state.
 The
 .Fn alq_post
 function is implemented as a wrapper around
-.Fn alq_postn
+.Fn alq_post_flags
 to provide backwards compatibility to consumers that have not been updated to
 utilise the newer
-.Fn alq_postn
+.Fn alq_post_flags
 function.
-It simply passes
-.Fa alq
-and
-.Fa ale
-through to
-.Fn alq_postn
+It simply passes all arguments through to
+.Fn alq_post_flags
 untouched, and sets
 .Fa flags
 to 0.
@@ -332,7 +353,7 @@ or
 and
 .Fn alq_post
 or
-.Fn alq_postn ,
+.Fn alq_post_flags ,
 so this method of writing to a queue is unsuitable for situations where the
 time between calls may be substantial.
 .Sh LOCKING