[src/trunk]: src document config_detach_children(9)

[plunky <plunky%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/29ac8977acfd
branches:  trunk
changeset: 777397:29ac8977acfd
user:      plunky <plunky%NetBSD.org@localhost>
date:      Fri Feb 17 09:44:12 2012 +0000

description:
document config_detach_children(9)

diffstat:

 distrib/sets/lists/comp/mi |   5 ++++-
 share/man/man9/Makefile    |   3 ++-
 share/man/man9/autoconf.9  |  18 ++++++++++++++++--
 3 files changed, 22 insertions(+), 4 deletions(-)

diffs (103 lines):

diff -r bba768a0e36b -r 29ac8977acfd distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi        Fri Feb 17 09:17:22 2012 +0000
+++ b/distrib/sets/lists/comp/mi        Fri Feb 17 09:44:12 2012 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: mi,v 1.1739 2012/02/16 18:40:29 njoly Exp $
+#      $NetBSD: mi,v 1.1740 2012/02/17 09:44:12 plunky Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -9819,6 +9819,7 @@
 ./usr/share/man/cat9/config_deactivate.0       comp-sys-catman         .cat
 ./usr/share/man/cat9/config_defer.0            comp-sys-catman         .cat
 ./usr/share/man/cat9/config_detach.0           comp-sys-catman         .cat
+./usr/share/man/cat9/config_detach_children.0  comp-sys-catman         .cat
 ./usr/share/man/cat9/config_finalize_register.0        comp-sys-catman         .cat
 ./usr/share/man/cat9/config_found.0            comp-sys-catman         .cat
 ./usr/share/man/cat9/config_found_ia.0         comp-sys-catman         .cat
@@ -16013,6 +16014,7 @@
 ./usr/share/man/html9/config_deactivate.html   comp-sys-htmlman        html
 ./usr/share/man/html9/config_defer.html                comp-sys-htmlman        html
 ./usr/share/man/html9/config_detach.html       comp-sys-htmlman        html
+./usr/share/man/html9/config_detach_children.html      comp-sys-htmlman        html
 ./usr/share/man/html9/config_finalize_register.html    comp-sys-htmlman        html
 ./usr/share/man/html9/config_found.html                comp-sys-htmlman        html
 ./usr/share/man/html9/config_found_ia.html     comp-sys-htmlman        html
@@ -22324,6 +22326,7 @@
 ./usr/share/man/man9/config_deactivate.9       comp-sys-man            .man
 ./usr/share/man/man9/config_defer.9            comp-sys-man            .man
 ./usr/share/man/man9/config_detach.9           comp-sys-man            .man
+./usr/share/man/man9/config_detach_children.9  comp-sys-man            .man
 ./usr/share/man/man9/config_finalize_register.9        comp-sys-man            .man
 ./usr/share/man/man9/config_found.9            comp-sys-man            .man
 ./usr/share/man/man9/config_found_ia.9         comp-sys-man            .man
diff -r bba768a0e36b -r 29ac8977acfd share/man/man9/Makefile
--- a/share/man/man9/Makefile   Fri Feb 17 09:17:22 2012 +0000
+++ b/share/man/man9/Makefile   Fri Feb 17 09:44:12 2012 +0000
@@ -1,4 +1,4 @@
-#       $NetBSD: Makefile,v 1.362 2011/12/04 21:08:45 jym Exp $
+#       $NetBSD: Makefile,v 1.363 2012/02/17 09:44:14 plunky Exp $
 
 #      Makefile for section 9 (kernel function and variable) manual pages.
 
@@ -117,6 +117,7 @@
        autoconf.9 config_attach.9 \
        autoconf.9 config_attach_pseudo.9 \
        autoconf.9 config_detach.9 \
+       autoconf.9 config_detach_children.9 \
        autoconf.9 config_deactivate.9 \
        autoconf.9 config_defer.9 \
        autoconf.9 config_interrupts.9 \
diff -r bba768a0e36b -r 29ac8977acfd share/man/man9/autoconf.9
--- a/share/man/man9/autoconf.9 Fri Feb 17 09:17:22 2012 +0000
+++ b/share/man/man9/autoconf.9 Fri Feb 17 09:44:12 2012 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: autoconf.9,v 1.28 2010/12/02 12:54:13 wiz Exp $
+.\"     $NetBSD: autoconf.9,v 1.29 2012/02/17 09:44:14 plunky Exp $
 .\"
 .\" Copyright (c) 2001, 2002 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd June 26, 2010
+.Dd February 17, 2012
 .Dt AUTOCONF 9
 .Os
 .Sh NAME
@@ -42,6 +42,7 @@
 .Nm config_attach ,
 .Nm config_attach_pseudo ,
 .Nm config_detach ,
+.Nm config_detach_children ,
 .Nm config_deactivate ,
 .Nm config_defer ,
 .Nm config_interrupts ,
@@ -81,6 +82,8 @@
 .Ft int
 .Fn config_detach "device_t dev" "int flags"
 .Ft int
+.Fn config_detach_children "device_t dev" "int flags"
+.Ft int
 .Fn config_deactivate "device_t dev"
 .Ft int
 .Fn config_defer "device_t dev" "void (*func)(device_t)"
@@ -348,6 +351,17 @@
 .Fn config_detach
 is always called from a thread context, allowing condition variables
 to be used while the device detaches itself.
+.It Fn config_detach_children "dev" "flags"
+Iterate through all attached devices, calling
+.Fn config_detach
+for each child of
+.Fa dev ,
+passing
+.Fa flags .
+If detaching any child results in an error, the iteration will halt
+and any remaining devices will not be detached.
+.Fn config_detach_children
+returns zero if successful and an error code otherwise.
 .It Fn config_deactivate "dev"
 Called by the parent to deactivate the child device
 .Fa dev .