[src/nathanw_sa]: src/lib/libc/gen Document _lwp_makecontext(3).

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

details:   https://anonhg.NetBSD.org/src/rev/068abef69b9e
branches:  nathanw_sa
changeset: 506776:068abef69b9e
user:      thorpej <thorpej%NetBSD.org@localhost>
date:      Fri Jan 17 03:45:59 2003 +0000

description:
Document _lwp_makecontext(3).

diffstat:

 lib/libc/gen/Makefile.inc       |   3 +-
 lib/libc/gen/_lwp_makecontext.3 |  81 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+), 1 deletions(-)

diffs (102 lines):

diff -r 3f4f591dd8d5 -r 068abef69b9e lib/libc/gen/Makefile.inc
--- a/lib/libc/gen/Makefile.inc Fri Jan 17 03:36:40 2003 +0000
+++ b/lib/libc/gen/Makefile.inc Fri Jan 17 03:45:59 2003 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile.inc,v 1.106.2.8 2002/10/18 02:15:43 nathanw Exp $
+#      $NetBSD: Makefile.inc,v 1.106.2.9 2003/01/17 03:45:59 thorpej Exp $
 #      from: @(#)Makefile.inc  8.6 (Berkeley) 5/4/95
 
 # gen sources
@@ -48,6 +48,7 @@
        humanize_number.3 initgroups.3 isalnum.3 isalpha.3 isascii.3 \
        isblank.3 iscntrl.3 isdigit.3 isgraph.3 isinf.3 islower.3 isprint.3 \
        ispunct.3 isspace.3 isupper.3 isxdigit.3 ldexp.3 lockf.3 \
+       _lwp_makecontext.3 \
        modf.3 nice.3 nlist.3 pause.3 popen.3 psignal.3 pwcache.3 \
        raise.3 realpath.3 scandir.3 setjmp.3 setmode.3 \
        setproctitle.3 shquote.3 siginterrupt.3 signal.3 sigsetops.3 sleep.3 \
diff -r 3f4f591dd8d5 -r 068abef69b9e lib/libc/gen/_lwp_makecontext.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/gen/_lwp_makecontext.3   Fri Jan 17 03:45:59 2003 +0000
@@ -0,0 +1,81 @@
+.\"    $NetBSD: _lwp_makecontext.3,v 1.1.2.1 2003/01/17 03:46:00 thorpej Exp $
+.\"
+.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jason R. Thorpe of Wasabi Systems, Inc.
+.\"
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"        This product includes software developed by the NetBSD
+.\"        Foundation, Inc. and its contributors.
+.\" 4. Neither the name of The NetBSD Foundation nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific prior written permission.
+.\"
+.\" 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 January 16, 2003
+.Dt _LWP_MAKECONTEXT 3
+.Os
+.Sh NAME
+.Nm _lwp_makecontext
+.Nd create a new initial light-weight process execution context
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.Fd #include \*[Lt]lwp.h\*[Gt]
+.Ft void
+.Fn _lwp_makecontext "ucontext_t *context" "void (*start_routine)(void *)" \
+    "void *arg" "void *private" "caddr_t stack_base" "size_t stack_size"
+.Sh DESCRIPTION
+.Fn _lwp_makecontext
+initializes the context structure pointed to by
+.Fa context
+in a manner suitable for using with
+.Xr _lwp_create 2 .
+The LWP will begin execution at the function specified by
+.Fa start_routine
+which will be passed a single argument
+.Fa arg .
+The LWP private data pointer will be set to
+.Fa private .
+The stack region for the new LWP is specified by the
+.Fa stack_base
+and
+.Fa stack_size
+arguments.
+.Pp
+The signal mask in the context structure is not initialized by
+.Fn _lwp_makecontext .
+.Sh SEE ALSO
+.Xr _lwp_create 2 ,
+.Xr _lwp_getprivate 2
+.Sh HISTORY
+The
+.Fn _lwp_create
+system call first appeared in
+.Nx 2.0 .
+.Sh BUGS
+The LWP private data pointer is not initialized by the current
+implementation of
+.Fn _lwp_makecontext .