diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2019-08-26 14:38:14 +0100 |
---|---|---|
committer | Peter Tribble <peter.tribble@gmail.com> | 2019-08-27 21:04:45 +0100 |
commit | c5806743f70246f7f708e57514b9103a6291d629 (patch) | |
tree | a9b2a46d7e707a21b6a9c05e9c6a773e34fa073f /usr/src/man/man5 | |
parent | 6ae02400ec7326832d2e19e92b4174ec778b2b9f (diff) | |
download | illumos-joyent-c5806743f70246f7f708e57514b9103a6291d629.tar.gz |
11622 clean up rarer mandoc lint warnings
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Toomas Soome <tsoome@me.com>
Approved by: Robert Mustacchi <rm@joyent.com>
Diffstat (limited to 'usr/src/man/man5')
-rw-r--r-- | usr/src/man/man5/epoll.5 | 9 | ||||
-rw-r--r-- | usr/src/man/man5/threads.5 | 18 |
2 files changed, 2 insertions, 25 deletions
diff --git a/usr/src/man/man5/epoll.5 b/usr/src/man/man5/epoll.5 index 860b2bb91f..1cf5d39947 100644 --- a/usr/src/man/man5/epoll.5 +++ b/usr/src/man/man5/epoll.5 @@ -4,7 +4,7 @@ .\" Common Development and Distribution License ("CDDL"), version 1.0. .\" You may only use this file in accordance with the terms of version .\" 1.0 of the CDDL. -.\" +.\" .\" A full copy of the text of the CDDL should have accompanied this .\" source. A copy of the CDDL is also available via the Internet at .\" http://www.illumos.org/license/CDDL. @@ -12,15 +12,11 @@ .SH NAME epoll \- Linux-compatible I/O event notification facility .SH SYNOPSIS - -.LP .nf #include <sys/epoll.h> .fi .SH DESCRIPTION -.LP - \fBepoll\fR is a facility for efficient event-oriented I/O that has a similar model to \fBpoll\fR(2), but does not necessitate rescanning a set of file descriptors to wait for an event. \fBepoll\fR is of Linux @@ -70,8 +66,6 @@ to waiting for events. .sp .SH NOTES -.LP - The \fBepoll\fR facility is implemented for purposes of offering compatibility to and portability of Linux-borne applications; native applications should continue to prefer using event ports @@ -102,7 +96,6 @@ will always result in no further events being generated for that event description. .SH SEE ALSO -.LP \fBepoll_create\fR(3C), \fBepoll_create1\fR(3C), \fBepoll_ctl\fR(3C), \fBepoll_wait\fR(3C), \fBepoll_pwait\fR(3C), \fBport_create\fR(3C), \fBport_associate\fR(3C), \fBport_dissociate\fR(3C), diff --git a/usr/src/man/man5/threads.5 b/usr/src/man/man5/threads.5 index ddf0a2e51f..dea66af7b2 100644 --- a/usr/src/man/man5/threads.5 +++ b/usr/src/man/man5/threads.5 @@ -9,7 +9,6 @@ threads, pthreads \- POSIX pthreads, c11, and illumos threads concepts .SH SYNOPSIS .SS "POSIX" -.LP .nf gcc -D_REENTRANT [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] .fi @@ -20,7 +19,6 @@ gcc -D_REENTRANT [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] .fi .SS "C11" -.LP .nf gcc -std=c11 -D_REENTRANT [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] .fi @@ -31,7 +29,6 @@ gcc -std=c11 -D_REENTRANT [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] .fi .SS "illumos" -.LP .nf gcc -D_REENTRANT [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] .fi @@ -47,7 +44,6 @@ gcc -D_REENTRANT [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ] .fi .SH DESCRIPTION -.LP A thread is an independent source of execution within a process. Every process is created with a single thread, which calls the .B main @@ -84,14 +80,12 @@ threads are an optional part of ISO C11 and may not exist on every ISO C11 platform. POSIX, C11, and illumos threads require different source and include files. See \fBSYNOPSIS\fR. .SS "Similarities" -.LP Most of the POSIX and illumos threading functions have counterparts with each other. POSIX function names, with the exception of the semaphore names, have a "\fBpthread\fR" prefix. Function names for similar POSIX and illumos functions have similar endings. Typically, similar POSIX and illumos functions have the same number and use of arguments. .SS "Differences" -.LP POSIX pthreads and illumos threads differ in the following ways: .RS +4 .TP @@ -138,7 +132,6 @@ illumos threads implement daemon threads, for whose demise the process does not wait. .RE .SS "Comparison to C11 Threads" -.LP C11 threads are not as functional as either POSIX or illumos threads. C11 threads only support intra-process locking and do not have any form of readers/writer locking or semaphores. In general, POSIX threads will be more @@ -155,7 +148,6 @@ platform are encouraged to use POSIX threads, unless a portability concern dictates otherwise. .SH FUNCTION COMPARISON -.LP The following table compares the POSIX pthreads, C11 threads, and illumos threads functions. When a comparable interface is not available either in POSIX pthreads, C11 threads or illumos threads, a hyphen (\fB-\fR) appears in the @@ -336,7 +328,7 @@ l l l . \fBsem_init()\fR \fBsema_init()\fR \fB-\fR \fBsem_open()\fR \fB-\fR \fB-\fR \fBsem_close()\fR \fB-\fR \fB-\fR -\fBsem_wait()\fR \fBsema_wait()\ \fB-\fR +\fBsem_wait()\fR \fBsema_wait()\fR \fB-\fR \fBsem_trywait()\fR \fBsema_trywait()\fR \fB-\fR \fBsem_post()\fR \fBsema_post()\fR \fB-\fR \fBsem_getvalue()\fR \fB-\fR \fB-\fR @@ -373,7 +365,6 @@ l l l . .SH LOCKING .SS "Synchronization" -.LP Multithreaded behavior is asynchronous, and therefore, optimized for concurrent and parallel processing. As threads, always from within the same process and sometimes from multiple processes, share global data with each @@ -389,7 +380,6 @@ Synchronizing multiple threads diminishes their concurrency. The coarser the grain of synchronization, that is, the larger the block of code that is locked, the lesser the concurrency. .SS "MT \fBfork()\fR" -.LP If a threads program calls \fBfork\fR(2), it implicitly calls \fBfork1\fR(2), which replicates only the calling thread. Should there be any outstanding mutexes throughout the process, the application should call @@ -397,7 +387,6 @@ mutexes throughout the process, the application should call \fBfork()\fR. .SH SCHEDULING .SS "POSIX Threads" -.LP illumos supports the following three POSIX scheduling policies: .sp .ne 2 @@ -468,16 +457,13 @@ described in \fBpriocntl\fR(2). .RE .SS "illumos Threads" -.LP Only scheduling policy supported is \fBSCHED_OTHER\fR, which is timesharing, based on the \fBTS\fR scheduling class. .SH ERRORS -.LP In a multithreaded application, \fBEINTR\fR can be returned from blocking system calls when another thread calls \fBforkall\fR(2). .SH USAGE .SS "\fB-mt\fR compiler option" -.LP The \fB-mt\fR compiler option compiles and links for multithreaded code. It compiles source files with \(mi\fBD_REENTRANT\fR and augments the set of support libraries properly. @@ -487,7 +473,6 @@ Users of other compilers such as gcc and clang should manually set \(mi\fBD_REENTRANT\fR on the compilation line. There are no other libraries or flags necessary. .SH ATTRIBUTES -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -502,7 +487,6 @@ MT-Level MT-Safe, Fork 1-Safe .TE .SH SEE ALSO -.LP \fBcrle\fR(1), \fBfork\fR(2), \fBpriocntl\fR(2), \fBlibpthread\fR(3LIB), \fBlibrt\fR(3LIB), \fBlibthread\fR(3LIB), \fBpthread_atfork\fR(3C), \fBpthread_create\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) |