[src/trunk]: src Document td_thr_iter(3) from libpthread_dbg(3)

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

details:   https://anonhg.NetBSD.org/src/rev/c9566c80fe37
branches:  trunk
changeset: 349056:c9566c80fe37
user:      kamil <kamil%NetBSD.org@localhost>
date:      Tue Nov 22 00:07:40 2016 +0000

description:
Document td_thr_iter(3) from libpthread_dbg(3)

td_thr_iter - iterate over the threads in the process

Sponsored by <The NetBSD Foundation>

diffstat:

 distrib/sets/lists/comp/mi       |   5 ++-
 lib/libpthread_dbg/Makefile      |   3 +-
 lib/libpthread_dbg/td_thr_iter.3 |  69 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 75 insertions(+), 2 deletions(-)

diffs (123 lines):

diff -r fbbebf765ccb -r c9566c80fe37 distrib/sets/lists/comp/mi
--- a/distrib/sets/lists/comp/mi        Mon Nov 21 22:19:03 2016 +0000
+++ b/distrib/sets/lists/comp/mi        Tue Nov 22 00:07:40 2016 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: mi,v 1.2071 2016/11/21 22:19:03 kamil Exp $
+#      $NetBSD: mi,v 1.2072 2016/11/22 00:07:40 kamil Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 ./etc/mtree/set.comp                           comp-sys-root
@@ -9365,6 +9365,7 @@
 ./usr/share/man/cat3/td_close.0                        comp-c-catman           .cat
 ./usr/share/man/cat3/td_open.0                 comp-c-catman           .cat
 ./usr/share/man/cat3/td_thr_info.0             comp-c-catman           .cat
+./usr/share/man/cat3/td_thr_iter.0             comp-c-catman           .cat
 ./usr/share/man/cat3/tdelete.0                 comp-c-catman           .cat
 ./usr/share/man/cat3/telldir.0                 comp-c-catman           .cat
 ./usr/share/man/cat3/tempnam.0                 comp-c-catman           .cat
@@ -16624,6 +16625,7 @@
 ./usr/share/man/html3/td_close.html            comp-c-htmlman          html
 ./usr/share/man/html3/td_open.html             comp-c-htmlman          html
 ./usr/share/man/html3/td_thr_info.html         comp-c-htmlman          html
+./usr/share/man/html3/td_thr_iter.html         comp-c-htmlman          html
 ./usr/share/man/html3/tdelete.html             comp-c-htmlman          html
 ./usr/share/man/html3/telldir.html             comp-c-htmlman          html
 ./usr/share/man/html3/tempnam.html             comp-c-htmlman          html
@@ -23944,6 +23946,7 @@
 ./usr/share/man/man3/td_close.3                        comp-c-man              .man
 ./usr/share/man/man3/td_open.3                 comp-c-man              .man
 ./usr/share/man/man3/td_thr_info.3             comp-c-man              .man
+./usr/share/man/man3/td_thr_iter.3             comp-c-man              .man
 ./usr/share/man/man3/tdelete.3                 comp-c-man              .man
 ./usr/share/man/man3/telldir.3                 comp-c-man              .man
 ./usr/share/man/man3/tempnam.3                 comp-c-man              .man
diff -r fbbebf765ccb -r c9566c80fe37 lib/libpthread_dbg/Makefile
--- a/lib/libpthread_dbg/Makefile       Mon Nov 21 22:19:03 2016 +0000
+++ b/lib/libpthread_dbg/Makefile       Tue Nov 22 00:07:40 2016 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.13 2016/11/21 22:19:03 kamil Exp $
+#      $NetBSD: Makefile,v 1.14 2016/11/22 00:07:40 kamil Exp $
 #
 
 WARNS?=                5
@@ -43,6 +43,7 @@
 MAN+=  pthread_dbg.3
 MAN+=  td_open.3
 MAN+=  td_thr_info.3
+MAN+=  td_thr_iter.3
 
 MLINKS+=       td_open.3 td_close.3
 
diff -r fbbebf765ccb -r c9566c80fe37 lib/libpthread_dbg/td_thr_iter.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpthread_dbg/td_thr_iter.3  Tue Nov 22 00:07:40 2016 +0000
@@ -0,0 +1,69 @@
+.\"    $NetBSD: td_thr_iter.3,v 1.1 2016/11/22 00:07:40 kamil Exp $
+.\"
+.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd November 21, 2016
+.Dt TD_THR_ITER 3
+.Os
+.Sh NAME
+.Nm td_thr_iter
+.Nd iterate over the threads in the process
+.Sh LIBRARY
+.Lb libpthread_dbg
+.Sh SYNOPSIS
+.In pthread_dbg.h
+.Ft int
+.Fn td_thr_iter "td_proc_t *proc" "int (*call)(td_thread_t *, void *)" "void *callarg"
+.Sh DESCRIPTION
+The
+.Fn td_thr_iter
+function iterates over all threads in the
+.Fa proc
+process and calls
+.Fa call
+function for each of them
+with
+.Fa callarg
+argument.
+.Sh RETURN VALUES
+If successful, the
+.Nm
+function will return
+.Dv TD_ERR_OK .
+Otherwise an error number will be returned to indicate failure as described in
+.Xr pthread_dbg 3 .
+.Sh SEE ALSO
+.Xr pthread 3 ,
+.Xr pthread_dbg 3
+.Sh HISTORY
+The
+.Nm
+function first appeared in
+.Nx 2.0 .
+.Sh AUTHORS
+.An Nathan J. Williams Aq Mt nathanw%NetBSD.org@localhost
+.Pp
+This manual page was written by
+.An Kamil Rytarowski Aq Mt kamil%NetBSD.org@localhost .