d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add a stub libthr(3) man page to document what it is and why, as well as

Browse Source 
to point at libmap.conf(5).  This will help answer questions about what
and why it is, although not in great detail.

Approved by:	re (scottl)
MFC after:	1 week
MFC note:	When MFC'd, don't MFC mention of work not yet MFC'd.
This commit is contained in:
rwatson 2005-06-11 15:27:56 +00:00
parent f61b68bc01
commit 802ab290dd
2 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/libthr/Makefile
View File

@ -23,6 +23,8 @@ CFLAGS+=-Winline
LDFLAGS= -Wl,--version-script=${.CURDIR}/pthread.map
MAN= libthr.3
# enable extra internal consistancy checks
CFLAGS+=-D_PTHREADS_INVARIANTS -Wall
CFLAGS+=-g

72
lib/libthr/libthr.3 Normal file
View File

@ -0,0 +1,72 @@
.\" Copyright (c) 2005 Robert N. M. Watson
.\" 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 AUTHORS 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 AUTHORS 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.
.\"
.\" $FreeBSD$
.\"
.Dd June 11, 2005
.Os
.Dt LIBTHR 3
.Sh NAME
.Nm libthr
.Nd "alternative POSIX threads library"
.Sh LIBRARY
.Lb libthr
.Sh SYNOPSIS
.In pthread.h
.Sh DESCRIPTION
The
.Nm
library provides an alternative 1:1 implementation of the
.Xr pthread 3
library interfaces for application threading.
While applications may be linked directly against
.Nm ,
system administrators are offered maximum flexibility by linking against
.Xr pthread 3 ,
as they can then use
.Xr libmap.conf 5
to select the threading implementation on a per-application basis.
.Pp
.Nm
has been optimized for use by applications expecting system scope thread
semantics, and can provide significant performance improvements.
.Sh SEE ALSO
.Xr pthread 3 ,
.Sh AUTHORS
.An -nosplit
.Nm
was originally created by
.An "Jeff Roberson" Aq jeff@FreeBSD.org ,
and enhanced by
.An "Jonathan Mini" Aq mini@FreeBSD.org
and
.An "Mike Makonnen" Aq mtm@FreeBSD.org .
It has been substantially rewritten and optimized by
.An "David Xu" Aq davidxu@FreeBSD.org .
.An -split
.Sh BUGS
As
.Nm
is an optimized system scope thread library, it does not offer support for
scheduling threads as process scope threads.