svn commit: r217830 - head/share/man/man9

[Matthew D Fleming]

Author: mdf
Date: Tue Jan 25 17:39:52 2011
New Revision: 217830
URL: http://svn.freebsd.org/changeset/base/217830

Log:
  Document sbuf_new_for_sysctl(9).
  
  Pointed out by:	lstewart

Modified:
  head/share/man/man9/Makefile
  head/share/man/man9/sbuf.9

Modified: head/share/man/man9/Makefile
==============================================================================
--- head/share/man/man9/Makefile	Tue Jan 25 17:15:23 2011	(r217829)
+++ head/share/man/man9/Makefile	Tue Jan 25 17:39:52 2011	(r217830)
@@ -1031,6 +1031,7 @@ MLINKS+=sbuf.9 sbuf_bcat.9 \
 	sbuf.9 sbuf_finish.9 \
 	sbuf.9 sbuf_len.9 \
 	sbuf.9 sbuf_new.9 \
+	sbuf.9 sbuf_new_for_sysctl.9 \
 	sbuf.9 sbuf_printf.9 \
 	sbuf.9 sbuf_putc.9 \
 	sbuf.9 sbuf_set_drain.9 \

Modified: head/share/man/man9/sbuf.9
==============================================================================
--- head/share/man/man9/sbuf.9	Tue Jan 25 17:15:23 2011	(r217829)
+++ head/share/man/man9/sbuf.9	Tue Jan 25 17:39:52 2011	(r217830)
@@ -25,13 +25,14 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd May 17, 2009
+.Dd January 25, 2011
 .Dt SBUF 9
 .Os
 .Sh NAME
 .Nm sbuf ,
 .Nm sbuf_new ,
 .Nm sbuf_new_auto ,
+.Nm sbuf_new_for_sysctl ,
 .Nm sbuf_clear ,
 .Nm sbuf_setpos ,
 .Nm sbuf_bcat ,
@@ -99,6 +100,9 @@
 .Fn sbuf_done "struct sbuf *s"
 .Ft void
 .Fn sbuf_delete "struct sbuf *s"
+.In sys/sysctl.h
+.Ft struct sbuf *
+.Fn sbuf_new_for_sysctl "struct sbuf *s" "char *buf" "int length" "struct sysctl_req *req"
 .Sh DESCRIPTION
 The
 .Nm
@@ -169,6 +173,15 @@ and
 .Dv SBUF_AUTOEXTEND .
 .Pp
 The
+.Fn sbuf_new_for_sysctl
+function will set up an sbuf with a drain function to use
+.Fn SYSCTL_OUT
+when the internal buffer fills.
+The sysctl old buffer will be wired, which allows for doing an
+.Fn sbuf_printf
+while holding a mutex.
+.Pp
+The
 .Fn sbuf_delete
 function clears the
 .Fa sbuf