Commit Graph

295 Commits

Author SHA1 Message Date
Warner Losh
e4adaf642c Document that EPERM is returned when the calling thread does not have
the mutex locked.  Also tweak the wording to make it more consistant
between pthread_cond_wait and pthread_cond_tiedwait.

Confirmed with the opengroup's web site that this is a valid return
value.  Wording used specifically not that of opengroup's online man
pages.

MFC After: 1 week
2007-03-30 04:10:04 +00:00
Olivier Houchard
c3f5198b21 Add a reference too pthread_cancel(3).
Submitted by:	Jeremie Le-Hen
2007-01-19 17:34:52 +00:00
Tom Rhodes
6a8a30dcd3 Xref pthread_condattr.3, pthread_attr.3, and pthread_mutexattr.3.
PR:		60679
Submitted by:	roam (with minor modifications)
2006-11-04 10:08:16 +00:00
Maxim Konovalov
b889a97163 o Expand "Nov" to "November" in Dd macro, remove eol whitespace. 2006-11-01 04:46:06 +00:00
David Xu
29f4831b30 Add error code EPERM.
Reviewed by: ru, deischen
2006-11-01 01:54:30 +00:00
Ruslan Ermilov
a676ad7a4f Bring manpage up-to-date with respect to the scheduling priority
range, and mention the SCHED_OTHER scheduling policy.

Submitted by:	davidxu
PR:		docs/37843
MFC after:	3 days
2006-10-16 14:35:31 +00:00
Ruslan Ermilov
85213a8004 Revise markup. 2006-09-30 11:48:12 +00:00
Ruslan Ermilov
2e97500669 Removed libc_r build support. 2006-09-30 11:32:46 +00:00
Ruslan Ermilov
5bb9f2101b Remove mentions of libc_r. 2006-09-30 11:22:26 +00:00
Maxim Konovalov
0029d6425f o Add pthread_yield.3 man page.
PR:		docs/100083
Reviewed by:	deischen, ru
Obtained from:	OpenBSD
MFC after:	2 weeks
2006-09-18 18:07:49 +00:00
Ruslan Ermilov
81ae4b8da9 Markup fixes. 2006-09-18 15:24:20 +00:00
Ed Maste
d5fd66e17d The removal of CIRCLEQ left four queue macros. One sentence was missed
in the man page update.

PR:		docs/94938
Submitted by:	Ed Schouten <ed@fxq.nl>
MFC After:	3 days
2006-03-25 23:11:10 +00:00
Kirk McKusick
982ba1cb7e Typesetting fix for -r1.137.
If a tail queue is empty the return value of TAILQ_LAST is not
undefined, it is NULL.

Submitted by: Ruslan Ermilov <ru@FreeBSD.org>
2006-03-24 07:41:12 +00:00
Kirk McKusick
c4e29cccdd If a tail queue is empty the return value is not
undefined, it is NULL.
2006-03-22 02:40:38 +00:00
Ruslan Ermilov
e1fe3dba5c Reimplementation of world/kernel build options. For details, see:
http://lists.freebsd.org/pipermail/freebsd-current/2006-March/061725.html

The src.conf(5) manpage is to follow in a few days.

Brought to you by:	imp, jhb, kris, phk, ru (all bugs are mine)
2006-03-17 18:54:44 +00:00
Brad Davis
209462832d - Massage wording to make it easier to understand and fix some grammar.
Submitted by:	sbahra at gwu dot edu
Reviewed by:	ru@
Approved by:	ceri@
MFC after:	3 days
2006-02-16 09:56:31 +00:00
Tom Rhodes
a00d9cda62 Does not return EBUSY, the mutex will keep blocking until it's unlocked. 2006-01-31 01:47:16 +00:00
Jason Evans
d72cd77975 Add the RB_PROTOTYPE_STATIC and RB_GENERATE_STATIC macros.
Approved by:	markm (mentor)
2006-01-19 07:20:20 +00:00
Maxim Konovalov
7b7f29d82a o Sort MLINKS. 2006-01-11 21:28:55 +00:00
Jason Evans
06115e083a Add the RB_NFIND() macro, which is useful for red-black tree searches
for which there may not be an exact match.

Reviewed by:	glebius, julian
Approved by:	markm (mentor)
2006-01-11 15:48:36 +00:00
David Xu
dbcf945af6 Style fixs, add missing word 'signal'.
Reviewed by: deischen
2005-12-14 01:59:11 +00:00
David Xu
22fc836263 Add siginfo. 2005-12-13 00:28:09 +00:00
Ruslan Ermilov
4294a24e1b Fix prototype. 2005-11-24 15:10:38 +00:00
John Baldwin
e26af7a74a Remove a spurious newline. The TAILQ_INIT() is part of the 'faster tailq
deletion' example.

MFC after:	1 week
2005-10-17 17:53:17 +00:00
Hiroki Sato
44cb3ab02e Fix typos and use consistent section names in manual pages:
s/SYSCTLS/SYSCTL VARIABLES/
 s/TUNABLES/LOADER TUNABLES/
 s/CAVEAT/CAVEATS/
 s/DESCIPTION/DESCRIPTION/

Reviewed by:	ru
MFC after:	3 days
2005-07-15 17:35:26 +00:00
Hiten Pandya
a1601503f5 Use 'manual page' instead of 'man page' for consistency.
Approved by:	re (hrs)
2005-06-30 13:18:15 +00:00
Ruslan Ermilov
a4be0b3cc1 (Mostly) markup fixes.
Approved by:	re (blanket)
2005-06-16 18:46:17 +00:00
Giorgos Keramidas
8a119ad210 The correct copyright notice for manpages that copy material from Open
Group's documentation is `/usr/share/examples/mdoc/POSIX-copyright',
not the one I copied from `/usr/share/examples/etc/bsd-copyright'.

Suggested by:			simon
2nd pointy hat of the day:	yours truly
2005-05-18 17:08:15 +00:00
Giorgos Keramidas
a3c8fc5312 Add a manpage for pthread_atfork(3). This copies a lot of the text of
the Open Group manpage for pthread_atfork(), available online at:

http://www.opengroup.org/onlinepubs/009695399/functions/pthread_atfork.html

which should be ok, since Daniel Eischen had mailed me about Open
Group manpages and the fact that they have granted permission to
FreeBSD to use their material.  Any differences from the OG text are
my changes to the original manpage text submitted by Alex Vasylenko:

- In an effort to clean up the part that describes hooks and their
  calling order, I used a list instead of a single paragraph for all the three
  types of fork() hooks.
- After a short discussion with Dima Dorfman a long long time ago in a
  far away galaxy, I changed the RETURN VALUES section to look more
  like the rest of the pthread_xxx.3 manpages.

PR:		docs/68201
Submitted by:	Alex Vasylenko <lxv@omut.org>
2005-05-18 16:23:11 +00:00
David Schultz
7b74e4a759 Remove fpsetsticky(). This was added for SysV compatibility, but due
to mistakes from day 1, it has always had semantics inconsistent with
SVR4 and its successors.  In particular, given argument M:

- On Solaris and FreeBSD/{alpha,sparc64}, it clobbers the old flags
  and *sets* the new flag word to M.  (NetBSD, too?)
- On FreeBSD/{amd64,i386}, it *clears* the flags that are specified in M
  and leaves the remaining flags unchanged (modulo a small bug on amd64.)
- On FreeBSD/ia64, it is not implemented.

There is no way to fix fpsetsticky() to DTRT for both old FreeBSD apps
and apps ported from other operating systems, so the best approach
seems to be to kill the function and fix any apps that break.  I
couldn't find any ports that use it, and any such ports would already
be broken on FreeBSD/ia64 and Linux anyway.

By the way, the routine has always been undocumented in FreeBSD,
except for an MLINK to a manpage that doesn't describe it.  This
manpage has stated since 5.3-RELEASE that the functions it describes
are deprecated, so that must mean that functions that it is *supposed*
to describe but doesn't are even *more* deprecated.  ;-)

Note that fpresetsticky() has been retained on FreeBSD/i386.  As far
as I can tell, no other operating systems or ports of FreeBSD
implement it, so there's nothing for it to be inconsistent with.

PR:		75862
Suggested by:	bde
2005-03-15 15:53:39 +00:00
Ruslan Ermilov
0227791b40 Expand *n't contractions. 2005-02-13 22:25:33 +00:00
Tom Rhodes
61e68f057a Document EBUSY.
PR:		73387
Submitted by:	Thomas Ludwig <tludwig@smr.ch> (original version)
2005-02-08 20:16:59 +00:00
Ruslan Ermilov
3ac17feb8a Fixed xref. 2005-01-21 10:48:35 +00:00
Ruslan Ermilov
9cbda59000 Sort sections. 2005-01-21 08:36:40 +00:00
Ruslan Ermilov
e93572dedd Improved markup. 2005-01-13 11:22:29 +00:00
Tom Rhodes
ddbb94ad96 Some grammar, spelling, and mdoc(7) fixes. No content changes.
PR:		75581
Submitted by:	Nobuyuki Koganemaru n-kogane@syd.odn.ne.jp (original version)
2004-12-29 00:11:34 +00:00
Ruslan Ermilov
f1f6253f4f NOLIBC_R -> NO_LIBC_R
NOLIBPTHREAD -> NO_LIBPTHREAD
NOLIBTHR -> NO_LIBTHR
2004-12-21 09:00:26 +00:00
Joseph Koshy
6febaa3aff Mutually cross-reference sysexits(3) and err(3). Add text to err(3)
recommending that the standard exit codes in sysexits(3) be used.

Reviewed by:    ru
2004-10-04 14:04:37 +00:00
Ruslan Ermilov
710df706de Sort MAN and MLINKS in dictionary order ignoring case. 2004-09-19 06:11:45 +00:00
Stefan Farfeleder
fd51ce66aa Add a man page for tgmath.h.
Reviewed by:	keramida
2004-08-13 22:43:12 +00:00
Ruslan Ermilov
2410103c1d mdoc(7) fixes. 2004-07-07 19:57:16 +00:00
Ruslan Ermilov
e825f57623 Added missing punctuation. 2004-07-07 17:36:31 +00:00
Ruslan Ermilov
5203edcdc5 Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00
Ruslan Ermilov
d37ea99837 Removed trailing whitespace. 2004-07-02 19:07:33 +00:00
Mike Pritchard
3b96c71f73 Spelling fixes. 2004-06-21 14:54:43 +00:00
Ruslan Ermilov
715a028455 Fixed markup bugs. 2004-06-17 17:51:17 +00:00
Ruslan Ermilov
ef13db44d1 Fixed markup bugs.
Spell function correctly when talking about restarting after a signal.
2004-06-17 17:49:30 +00:00
David Schultz
d5499b02cf Cross-reference fenv(3). 2004-06-06 10:07:13 +00:00
Pawel Jakub Dawidek
f7b00e0696 Add missing links. 2004-06-04 10:14:55 +00:00
David Schultz
0cedc1338e Support for dynamic adjustment of FPU precision is only available on
i386 and amd64, so fp[gs]prec(3) don't exist on other platforms.

PR:		52882
2004-05-05 09:53:29 +00:00
Simon L. B. Nielsen
5b8ef52df0 Add a LIBRARY section.
Submitted by:	Craig Rodrigues <rodrigc@crodrigues.org>
PR:		docs/65208
2004-04-08 23:04:54 +00:00
Mike Makonnen
d4d7df5c0c Implement PThreads barriers and barrier attributes. 2004-02-19 13:51:52 +00:00
Mike Makonnen
dec04f43d9 o Implement the pthread_spin_* functions in libthr.
o Man pages
2004-01-22 15:31:56 +00:00
Ruslan Ermilov
b760de9691 Use a single style for share/man/ makefiles:
- Sort MAN and MLINKS in "dictionary" order ignoring case.

- For multi-value MAN and multi-pair MLINKS, put each value/pair
  on its own line, for easier sorting and so that further diffs
  are easier to see.
2004-01-20 10:27:23 +00:00
Mike Makonnen
104ff764e5 Add an implementation of pthread_rwlock_timed{rd,wr}lock() to libthr with
attendant documentation.
2004-01-16 10:52:10 +00:00
Ruslan Ermilov
c133f2ab6f Removed outdated text about libc_r replacing libc (it now provides
just libc functions wrappers), and updated text to match reality:
there are three threading libraries in FreeBSD these days.

Removed instructions of how not to build libc_r, it's documented in
the make.conf(5) manpage already.

Removed description of the FreeBSD-specific gcc(1) option, -pthread.
While it's still provided (for backwards compatibility reasons),
its usefulness is questionable.
2004-01-15 17:58:26 +00:00
Ruslan Ermilov
95e055a2cf Removed the IMPLEMENTATION NOTES section made redundant by not
putting libc_r into the LIBRARY section.
2004-01-15 16:13:49 +00:00
Ruslan Ermilov
69a16e1e28 pthread_multi_np() is implemented in all threading libraries.
pthread_single_np() is not implemented in libthr.
2004-01-15 16:12:11 +00:00
Ruslan Ermilov
bc5cc7732e Revert previous delta -- these interfaces aren't supported by libthr. 2004-01-15 16:07:52 +00:00
Ruslan Ermilov
f9f9d2e804 Document interfaces that are supported by libthr. 2004-01-15 15:59:00 +00:00
Ruslan Ermilov
8e750fa2e6 Assorted markup fixes. 2004-01-15 11:15:27 +00:00
Ruslan Ermilov
5360187e7a Spell POSIX threads library as "libpthread", mdoc(7) is smart
enough to render it as "-lkse" these days.
2004-01-14 21:53:19 +00:00
Ruslan Ermilov
ec7452f103 Have a single set of POSIX threads man pages. The LIBRARY section
of each manpage lists libraries that have corresponding interfaces
implemented.

Prodded by:	threads
Reviewed by:	deischen
2004-01-14 21:44:26 +00:00
Ruslan Ermilov
fac93adb3d This interface is not provided by libc_r. It is, on the other
hand, is also provided by libthr, but this will be addressed
later.
2004-01-14 21:12:39 +00:00
Ruslan Ermilov
e09cec395d Pull revision 1.13 from libpthread/man/pthread_mutex_init.3:
- Remove error code that can't be returned (and original description
  was not proper English)

PR:		docs/57434
2003-12-30 15:44:16 +00:00
Mike Makonnen
ec2456e2c2 Aargh, cvs add pthread_mutex_timedlock 2003-12-30 08:50:04 +00:00
Mike Makonnen
2aa9de1f77 o Implement pthread_mutex_timedlock(), which does not block indefinitely on
a mutex locked by another thread.
o document it: pthread_mutex_timedlock(3)
2003-12-30 08:44:55 +00:00
Dag-Erling Smørgrav
309e4b9b6d RB_EMPTY() applies to red-black trees, not splay trees. 2003-11-10 10:35:06 +00:00
Ruslan Ermilov
959d6c24f6 Get rid of duplicates. 2003-09-14 13:41:59 +00:00
Ruslan Ermilov
743d5d518c mdoc(7): Properly mark C headers. 2003-09-10 19:24:35 +00:00
Ruslan Ermilov
fe08efe680 mdoc(7): Use the new feature of the .In macro. 2003-09-08 19:57:22 +00:00
Alexander Kabaev
2724bce2d2 Add safe _FOREACH iterators to the rest of the queue.h types. 2003-08-14 14:49:26 +00:00
Bosko Milekic
4250a68e2d Document LIST_FOREACH_SAFE in queue(3).
Asked with "please" by Ruslan Ermilov.  I've always had a weakness
for "please".
2003-08-13 19:58:38 +00:00
Ruslan Ermilov
734ac3b543 mdoc(7) fixes.
Approved by:	re (blanket)
2003-05-24 19:53:08 +00:00
John Polstra
8c0d4b5f92 Add stub implementations of pthread_[gs]etconcurrency to libc_r and
libthr.  No changes were made to libpthread by request of deischen,
who will soon commit a real implementation for that library.

PR:		standards/50848
Submitted by:	Sergey A. Osokin <osa@freebsd.org.ru>
MFC after:	1 week
2003-04-20 01:53:13 +00:00
Philippe Charnier
9d09157a0f The .Fn function. Use .Xr where appropriate. 2003-03-24 16:05:24 +00:00
Ruslan Ermilov
ace5be682d mdoc(7) police: Scheduled sweep. 2003-02-24 22:53:26 +00:00
Alexey Zelkin
597cf12892 Add AUTHORS section 2003-02-13 22:11:19 +00:00
Alexey Zelkin
318d8cfd73 Finally! Document all undocumented functions in libc_r.
Add manual pages for following functions:

. pthread_attr_setcreatesuspend_np(3)
. pthread_main_np(3)
. pthread_multi_np(3)
. pthread_single_np(3)
. pthread_mutexattr_getkind_np(3)
. pthread_mutexattr_setkind_np(3)
. pthread_resume_all_np(3)
. pthread_resume_np(3)
. pthread_set_name_np(3)
. pthread_suspend_all_np(3)
. pthread_suspend_np(3)
. pthread_switch_add_np(3)
. pthread_switch_delete_np(3)

MFC after:	3 days
2003-02-13 22:10:10 +00:00
Alexey Zelkin
c18f0ff70c Break important implementation detail note into IMPLEMENTATION DETAILS
section. Add cross reference to pthread_attr_getstack() function.

MFC after:	1 day
2003-02-13 18:39:06 +00:00
Alexey Zelkin
41dd2d2dfa Add cross reference for pthread_attr_get_np() 2003-02-13 18:36:48 +00:00
Alfred Perlstein
4e44912c6c Add pthread_attr_getstack() and pthread_attr_setstack().
Submitted by: Craig Rodrigues <rodrigc@attbi.com>
2003-02-10 08:48:04 +00:00
Philippe Charnier
6f673fd1c0 The .Fn function 2003-02-06 11:10:32 +00:00
Alexey Zelkin
f3cf900844 Document additional behaviour of this function (see
rev 1.3 of uthread_attr_get_np.c)
2003-02-03 10:10:40 +00:00
Max Khon
f7ed1917e2 pthread_attr_get_np() now takes 'pthread_t' (not 'pthread_t *')
to be consistent with other pthread_XXX functions
2003-01-07 21:43:30 +00:00
Jens Schweikhardt
57bd0fc6e8 english(4) police. 2002-12-27 12:15:40 +00:00
Ruslan Ermilov
facc67676f mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00
Ruslan Ermilov
c8d40b7d34 mdoc(7) police: sort xrefs in SEE ALSO. 2002-12-13 16:53:51 +00:00
Ruslan Ermilov
480565d5e4 mdoc(7) police: markup overhaul. 2002-12-13 15:27:27 +00:00
Ruslan Ermilov
8d5d039f80 Uniformly refer to a file system as "file system".
Approved by:	re
2002-12-12 17:26:04 +00:00
Ruslan Ermilov
e199383992 mdoc(7) police: overhaul. 2002-12-09 12:41:29 +00:00
Ruslan Ermilov
ae82896268 Consistently mark std(in|out|err) with .Dv, because that's how they
are marked up in stdio(3), and because they are defined expressions
of type "FILE *".

Approved by:	re
2002-12-04 18:57:46 +00:00
Ruslan Ermilov
d962d52ac0 mdoc(7) police: scheduled sweep.
Approved by:	re
2002-11-29 11:39:20 +00:00
Alexey Zelkin
1f1e884a91 Add & hookup manpage for pthread_attr_get_np(3).
MFC after:	3 days
2002-10-26 15:04:29 +00:00
Tim J. Robbins
9c78e04d62 Make the example "assertion failure" message match reality. 2002-10-25 14:22:20 +00:00
Tim J. Robbins
a40c540ffa Update the Standards section for the addition of the C99 va_copy macro. 2002-10-25 12:22:14 +00:00
Mike Barcroft
86954511d2 Implement C99's va_copy() macro. 2002-09-18 07:33:16 +00:00
Maxim Konovalov
25a6539985 Fix a typo.
MFC after:	3 days
2002-07-10 09:06:42 +00:00
Dag-Erling Smørgrav
f191b6f96c Install the tree(3) man page. 2002-06-23 14:44:32 +00:00
Dag-Erling Smørgrav
c83272f713 This commit was generated by cvs2svn to compensate for changes in r98681,
which included commits to RCS files with non-trunk default branches.
2002-06-23 14:41:09 +00:00