From ff40dbb354be48759607eef6bb672907a6c59291 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sat, 16 Jan 2010 17:43:10 +0100 Subject: [PATCH] accept.2, connect.2, eventfd.2, flock.2, open.2, posix_fadvise.2, read.2, recv.2, sched_setscheduler.2, select_tut.2, send.2, signalfd.2, splice.2, timerfd_create.2, write.2, flockfile.3, mkfifo.3, mq_notify.3, mq_open.3, pthread_tryjoin_np.3, scanf.3, random.4, ddp.7, epoll.7, fifo.7, ip.7, pipe.7, socket.7, spufs.7: Global fix: s/non-blocking/nonblocking/ The tendency in English, as prescribed in style guides like Chicago MoS, is towards removing hyphens after prefixes like "non-" etc. Signed-off-by: Michael Kerrisk --- man2/accept.2 | 6 +++--- man2/connect.2 | 4 ++-- man2/eventfd.2 | 4 ++-- man2/flock.2 | 2 +- man2/open.2 | 2 +- man2/posix_fadvise.2 | 2 +- man2/read.2 | 4 ++-- man2/recv.2 | 6 +++--- man2/sched_setscheduler.2 | 2 +- man2/select_tut.2 | 6 +++--- man2/send.2 | 8 ++++---- man2/signalfd.2 | 2 +- man2/splice.2 | 2 +- man2/timerfd_create.2 | 2 +- man2/write.2 | 4 ++-- man3/flockfile.3 | 2 +- man3/mkfifo.3 | 2 +- man3/mq_notify.3 | 2 +- man3/mq_open.3 | 2 +- man3/pthread_tryjoin_np.3 | 2 +- man3/scanf.3 | 2 +- man4/random.4 | 2 +- man7/ddp.7 | 4 ++-- man7/epoll.7 | 8 ++++---- man7/fifo.7 | 4 ++-- man7/ip.7 | 4 ++-- man7/pipe.7 | 2 +- man7/socket.7 | 4 ++-- man7/spufs.7 | 4 ++-- 29 files changed, 50 insertions(+), 50 deletions(-) diff --git a/man2/accept.2 b/man2/accept.2 index b2e3ce1ea..f1cf0baf3 100644 --- a/man2/accept.2 +++ b/man2/accept.2 @@ -110,11 +110,11 @@ will return a value greater than was supplied to the call. .PP If no pending connections are present on the queue, and the socket is not marked as -non-blocking, +nonblocking, .BR accept () blocks the caller until a connection is present. If the socket is marked -non-blocking and no pending connections are present on the queue, +nonblocking and no pending connections are present on the queue, .BR accept () fails with the error .BR EAGAIN @@ -213,7 +213,7 @@ and .TP .BR EAGAIN " or " EWOULDBLOCK .\" Actually EAGAIN on Linux -The socket is marked non-blocking and no connections are +The socket is marked nonblocking and no connections are present to be accepted. POSIX.1-2001 allows either error to be returned for this case, and does not require these constants to have the same value, diff --git a/man2/connect.2 b/man2/connect.2 index 1fd5293fe..ea1367e3c 100644 --- a/man2/connect.2 +++ b/man2/connect.2 @@ -162,7 +162,7 @@ see the description of for information on how to increase the number of local ports. .TP .B EALREADY -The socket is non-blocking and a previous connection attempt has not yet +The socket is nonblocking and a previous connection attempt has not yet been completed. .TP .B EBADF @@ -175,7 +175,7 @@ No-one listening on the remote address. The socket structure address is outside the user's address space. .TP .B EINPROGRESS -The socket is non-blocking and the connection cannot be completed +The socket is nonblocking and the connection cannot be completed immediately. It is possible to .BR select (2) diff --git a/man2/eventfd.2 b/man2/eventfd.2 index 346e9316b..88ca50dd7 100644 --- a/man2/eventfd.2 +++ b/man2/eventfd.2 @@ -82,7 +82,7 @@ If the counter is zero at the time of the then the call either blocks until the counter becomes nonzero, or fails with the error .B EAGAIN -if the file descriptor has been made non-blocking. +if the file descriptor has been made nonblocking. .IP A .BR read (2) @@ -105,7 +105,7 @@ either blocks until a is performed on the file descriptor, or fails with the error .B EAGAIN -if the file descriptor has been made non-blocking. +if the file descriptor has been made nonblocking. .IP A .BR write (2) diff --git a/man2/flock.2 b/man2/flock.2 index cee8576c9..f009ea33a 100644 --- a/man2/flock.2 +++ b/man2/flock.2 @@ -61,7 +61,7 @@ Remove an existing lock held by this process. A call to .BR flock () may block if an incompatible lock is held by another process. -To make a non-blocking request, include +To make a nonblocking request, include .B LOCK_NB (by .IR OR ing) diff --git a/man2/open.2 b/man2/open.2 index c2468d51f..4f186eb8c 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -401,7 +401,7 @@ followed. .\" used\fP. .TP .BR O_NONBLOCK " or " O_NDELAY -When possible, the file is opened in non-blocking mode. +When possible, the file is opened in nonblocking mode. Neither the .BR open () nor any subsequent operations on the file descriptor which is diff --git a/man2/posix_fadvise.2 b/man2/posix_fadvise.2 index 95e9cb93f..838c1b954 100644 --- a/man2/posix_fadvise.2 +++ b/man2/posix_fadvise.2 @@ -109,7 +109,7 @@ These changes affect the entire file, not just the specified region (but other open file handles to the same file are unaffected). \fBPOSIX_FADV_WILLNEED\fP initiates a -non-blocking read of the specified region into the page cache. +nonblocking read of the specified region into the page cache. The amount of data read may be decreased by the kernel depending on virtual memory load. (A few megabytes will usually be fully satisfied, diff --git a/man2/read.2 b/man2/read.2 index be0afddaa..c166ef04a 100644 --- a/man2/read.2 +++ b/man2/read.2 @@ -79,7 +79,7 @@ the file position (if any) changes. .B EAGAIN The file descriptor .I fd -refers to a file other than a socket and has been marked non-blocking +refers to a file other than a socket and has been marked nonblocking .RB ( O_NONBLOCK ), and the read would block. .TP @@ -87,7 +87,7 @@ and the read would block. .\" Actually EAGAIN on Linux The file descriptor .I fd -refers to a socket and has been marked non-blocking +refers to a socket and has been marked nonblocking .RB ( O_NONBLOCK ), and the read would block. POSIX.1-2001 allows either error to be returned for this case, diff --git a/man2/recv.2 b/man2/recv.2 index 357f882b5..cce9d6a46 100644 --- a/man2/recv.2 +++ b/man2/recv.2 @@ -110,7 +110,7 @@ bytes may be discarded depending on the type of socket the message is received from. .PP If no messages are available at the socket, the receive calls wait for a -message to arrive, unless the socket is non-blocking (see +message to arrive, unless the socket is nonblocking (see .BR fcntl (2)), in which case the value \-1 is returned and the external variable .I errno @@ -145,7 +145,7 @@ flag of .BR open (2). .TP .BR MSG_DONTWAIT " (since Linux 2.2)" -Enables non-blocking operation; if the operation would block, +Enables nonblocking operation; if the operation would block, the call fails with the error .BR EAGAIN " or " EWOULDBLOCK (this can also be enabled using the @@ -396,7 +396,7 @@ see their manual pages. .TP .BR EAGAIN " or " EWOULDBLOCK .\" Actually EAGAIN on Linux -The socket is marked non-blocking and the receive operation +The socket is marked nonblocking and the receive operation would block, or a receive timeout had been set and the timeout expired before data was received. POSIX.1-2001 allows either error to be returned for this case, diff --git a/man2/sched_setscheduler.2 b/man2/sched_setscheduler.2 index 4434b0dcb..69d2c8bce 100644 --- a/man2/sched_setscheduler.2 +++ b/man2/sched_setscheduler.2 @@ -342,7 +342,7 @@ paging delays; this can be done with or .BR mlockall (2). -Since a non-blocking infinite loop in a process scheduled under +Since a nonblocking infinite loop in a process scheduled under \fBSCHED_FIFO\fP or \fBSCHED_RR\fP will block all processes with lower priority forever, a software developer should always keep available on the console a shell scheduled under a higher static priority than the diff --git a/man2/select_tut.2 b/man2/select_tut.2 index ba2230625..b450b7b6c 100644 --- a/man2/select_tut.2 +++ b/man2/select_tut.2 @@ -336,7 +336,7 @@ come across behavior that is difficult to understand and produces non-portable or borderline results. For instance, the above program is carefully written not to block at any point, even though it does not set its file descriptors to -non-blocking mode. +nonblocking mode. It is easy to introduce subtle errors that will remove the advantage of using .BR select (), @@ -410,7 +410,7 @@ set to \fBEAGAIN\fP (\fBEWOULDBLOCK\fP). These results must be properly managed (not done properly above). If your program is not going to receive any signals, then it is unlikely you will get \fBEINTR\fP. -If your program does not set non-blocking I/O, +If your program does not set nonblocking I/O, you will not get \fBEAGAIN\fP. .\" Nonetheless, you should still cope with these errors for completeness. .TP @@ -804,7 +804,7 @@ You might think it more efficient to use a .BR fork (2) call and devote a thread to each stream. This becomes more tricky than you might suspect. -Another idea is to set non-blocking I/O using +Another idea is to set nonblocking I/O using .BR fcntl (2). This also has its problems because you end up using inefficient timeouts. diff --git a/man2/send.2 b/man2/send.2 index 21f5b4304..c99b77aaf 100644 --- a/man2/send.2 +++ b/man2/send.2 @@ -145,9 +145,9 @@ Locally detected errors are indicated by a return value of \-1. .PP When the message does not fit into the send buffer of the socket, .BR send () -normally blocks, unless the socket has been placed in non-blocking I/O +normally blocks, unless the socket has been placed in nonblocking I/O mode. -In non-blocking mode it would fail with the error +In nonblocking mode it would fail with the error .B EAGAIN or .B EWOULDBLOCK @@ -185,7 +185,7 @@ This is only defined for protocol families that route; packet sockets don't. .TP .BR MSG_DONTWAIT " (since Linux 2.2)" -Enables non-blocking operation; if the operation would block, +Enables nonblocking operation; if the operation would block, .B EAGAIN or .B EWOULDBLOCK @@ -291,7 +291,7 @@ the path prefix. .TP .BR EAGAIN " or " EWOULDBLOCK .\" Actually EAGAIN on Linux -The socket is marked non-blocking and the requested operation +The socket is marked nonblocking and the requested operation would block. POSIX.1-2001 allows either error to be returned for this case, and does not require these constants to have the same value, diff --git a/man2/signalfd.2 b/man2/signalfd.2 index be0209912..05d3b0894 100644 --- a/man2/signalfd.2 +++ b/man2/signalfd.2 @@ -135,7 +135,7 @@ either blocks until one of the signals in is generated for the process, or fails with the error .B EAGAIN -if the file descriptor has been made non-blocking. +if the file descriptor has been made nonblocking. .TP .BR poll "(2), " select "(2) (and similar)" The file descriptor is readable diff --git a/man2/splice.2 b/man2/splice.2 index bbfad10f4..6751e5150 100644 --- a/man2/splice.2 +++ b/man2/splice.2 @@ -98,7 +98,7 @@ in the future, a correct implementation may be restored. .TP .B SPLICE_F_NONBLOCK Do not block on I/O. -This makes the splice pipe operations non-blocking, but +This makes the splice pipe operations nonblocking, but .BR splice () may nevertheless block because the file descriptors that are spliced to/from may block (unless they have the diff --git a/man2/timerfd_create.2 b/man2/timerfd_create.2 index 4bc662477..788bd31bd 100644 --- a/man2/timerfd_create.2 +++ b/man2/timerfd_create.2 @@ -222,7 +222,7 @@ If no timer expirations have occurred at the time of the then the call either blocks until the next timer expiration, or fails with the error .B EAGAIN -if the file descriptor has been made non-blocking +if the file descriptor has been made nonblocking (via the use of the .BR fcntl (2) .B F_SETFL diff --git a/man2/write.2 b/man2/write.2 index f093de1fa..3f31a3182 100644 --- a/man2/write.2 +++ b/man2/write.2 @@ -109,7 +109,7 @@ the results are not specified. .B EAGAIN The file descriptor .I fd -refers to a file other than a socket and has been marked non-blocking +refers to a file other than a socket and has been marked nonblocking .RB ( O_NONBLOCK ), and the write would block. .TP @@ -117,7 +117,7 @@ and the write would block. .\" Actually EAGAIN on Linux The file descriptor .I fd -refers to a socket and has been marked non-blocking +refers to a socket and has been marked nonblocking .RB ( O_NONBLOCK ), and the write would block. POSIX.1-2001 allows either error to be returned for this case, diff --git a/man3/flockfile.3 b/man3/flockfile.3 index f27b4e4af..b048e48ff 100644 --- a/man3/flockfile.3 +++ b/man3/flockfile.3 @@ -101,7 +101,7 @@ function decrements the lock count. .LP The .BR ftrylockfile () -function is a non-blocking version +function is a nonblocking version of .BR flockfile (). It does nothing in case some other thread diff --git a/man3/mkfifo.3 b/man3/mkfifo.3 index 961f6326f..35b46b5f5 100644 --- a/man3/mkfifo.3 +++ b/man3/mkfifo.3 @@ -57,7 +57,7 @@ Opening a FIFO for reading normally blocks until some other process opens the same FIFO for writing, and vice versa. See .BR fifo (7) -for non-blocking handling of FIFO special files. +for nonblocking handling of FIFO special files. .SH "RETURN VALUE" On success .BR mkfifo () diff --git a/man3/mq_notify.3 b/man3/mq_notify.3 index b17a7bb7e..32d729e4e 100644 --- a/man3/mq_notify.3 +++ b/man3/mq_notify.3 @@ -161,7 +161,7 @@ it can use .BR mq_notify () to request a further notification. This should be done before emptying all unread messages from the queue. -(Placing the queue in non-blocking mode is useful for emptying +(Placing the queue in nonblocking mode is useful for emptying the queue of messages without blocking once it is empty.) .SH RETURN VALUE On success diff --git a/man3/mq_open.3 b/man3/mq_open.3 index fe2e1cda9..514e9c64f 100644 --- a/man3/mq_open.3 +++ b/man3/mq_open.3 @@ -71,7 +71,7 @@ in .IR oflag : .TP .B O_NONBLOCK -Open the queue in non-blocking mode. +Open the queue in nonblocking mode. In circumstances where .BR mq_receive (3) and diff --git a/man3/pthread_tryjoin_np.3 b/man3/pthread_tryjoin_np.3 index 156845395..5589d949c 100644 --- a/man3/pthread_tryjoin_np.3 +++ b/man3/pthread_tryjoin_np.3 @@ -44,7 +44,7 @@ except for the differences described on this page. The .BR pthread_tryjoin_np () -function performs a non-blocking join with the thread +function performs a nonblocking join with the thread .IR thread , returning the exit status of the thread in .IR *retval . diff --git a/man3/scanf.3 b/man3/scanf.3 index 917faf59a..90b3eaada 100644 --- a/man3/scanf.3 +++ b/man3/scanf.3 @@ -540,7 +540,7 @@ is set indicate the error. .B EAGAIN The file descriptor underlying .I stream -is marked non-blocking, and the read operation would block. +is marked nonblocking, and the read operation would block. .TP .B EBADF The file descriptor underlying diff --git a/man4/random.4 b/man4/random.4 index c9fd47a25..d4a0d923b 100644 --- a/man4/random.4 +++ b/man4/random.4 @@ -66,7 +66,7 @@ soon as it is reloaded in the boot sequence, and perfectly adequate for network encryption session keys. Since reads from .I /dev/random -may block, users will usually want to open it in non-blocking mode +may block, users will usually want to open it in nonblocking mode (or perform a read with timeout), and provide some sort of user notification if the desired entropy is not immediately available. diff --git a/man7/ddp.7 b/man7/ddp.7 index f7562aff7..3d97ef1e7 100644 --- a/man7/ddp.7 +++ b/man7/ddp.7 @@ -161,10 +161,10 @@ A nonexistent interface was requested or the requested source address was not local. .TP .B EAGAIN -Operation on a non-blocking socket would block. +Operation on a nonblocking socket would block. .TP .B EALREADY -A connection operation on a non-blocking socket is already in progress. +A connection operation on a nonblocking socket is already in progress. .TP .B ECONNABORTED A connection was closed during an diff --git a/man7/epoll.7 b/man7/epoll.7 index ff673713d..4c188a1a8 100644 --- a/man7/epoll.7 +++ b/man7/epoll.7 @@ -122,7 +122,7 @@ might block indefinitely. An application that employs the .B EPOLLET -flag should use non-blocking file descriptors to avoid having a blocking +flag should use nonblocking file descriptors to avoid having a blocking read or write starve a task that is handling multiple file descriptors. The suggested way to use .B epoll @@ -132,7 +132,7 @@ interface is as follows: .RS .TP 4 .B i -with non-blocking file descriptors; and +with nonblocking file descriptors; and .TP .B ii by waiting for an event only after @@ -200,7 +200,7 @@ semantics as the edge-triggered usage requires more clarification to avoid stalls in the application event loop. In this example, listener is a -non-blocking socket on which +nonblocking socket on which .BR listen (2) has been called. The function @@ -454,7 +454,7 @@ Receiving an event from .BR epoll_wait (2) should suggest to you that such file descriptor is ready for the requested I/O operation. -You must consider it ready until the next (non-blocking) +You must consider it ready until the next (nonblocking) read/write yields .BR EAGAIN . When and how you will use the file descriptor is entirely up to you. diff --git a/man7/fifo.7 b/man7/fifo.7 index d0da69ac4..e28d0c221 100644 --- a/man7/fifo.7 +++ b/man7/fifo.7 @@ -30,7 +30,7 @@ before data can be passed. Normally, opening the FIFO blocks until the other end is opened also. .PP -A process can open a FIFO in non-blocking mode. +A process can open a FIFO in nonblocking mode. In this case, opening for read only will succeed even if no-one has opened on the write side yet, opening for write only will @@ -40,7 +40,7 @@ fail with end has already been opened. .PP Under Linux, opening a FIFO for read and write will succeed -both in blocking and non-blocking mode. +both in blocking and nonblocking mode. POSIX leaves this behavior undefined. This can be used to open a FIFO for diff --git a/man7/ip.7 b/man7/ip.7 index 3013f1f81..fc1334463 100644 --- a/man7/ip.7 +++ b/man7/ip.7 @@ -878,10 +878,10 @@ A nonexistent interface was requested or the requested source address was not local. .TP .B EAGAIN -Operation on a non-blocking socket would block. +Operation on a nonblocking socket would block. .TP .B EALREADY -An connection operation on a non-blocking socket is already in progress. +An connection operation on a nonblocking socket is already in progress. .TP .B ECONNABORTED A connection was closed during an diff --git a/man7/pipe.7 b/man7/pipe.7 index 5946ff3df..a59afdf5c 100644 --- a/man7/pipe.7 +++ b/man7/pipe.7 @@ -150,7 +150,7 @@ to be at least 512 bytes. (On Linux, .B PIPE_BUF is 4096 bytes.) -The precise semantics depend on whether the file descriptor is non-blocking +The precise semantics depend on whether the file descriptor is nonblocking .RB ( O_NONBLOCK ), whether there are multiple writers to the pipe, and on .IR n , diff --git a/man7/socket.7 b/man7/socket.7 index b8c4433a6..77a181028 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -105,7 +105,7 @@ or .BR pwrite (2) with a nonzero position is not supported on sockets. .PP -It is possible to do non-blocking I/O on sockets by setting the +It is possible to do nonblocking I/O on sockets by setting the .B O_NONBLOCK flag on a socket file descriptor using .BR fcntl (2). @@ -425,7 +425,7 @@ set to or .B EWOULDBLOCK .\" in fact to EAGAIN -just as if the socket was specified to be non-blocking. +just as if the socket was specified to be nonblocking. If the timeout is set to zero (the default) then the operation will never timeout. Timeouts only have effect for system calls that perform socket I/O (e.g., diff --git a/man7/spufs.7 b/man7/spufs.7 index 3a356c70b..3acdad7f2 100644 --- a/man7/spufs.7 +++ b/man7/spufs.7 @@ -171,7 +171,7 @@ flag. .I /mbox The first SPU-to-CPU communication mailbox. This file is read-only and can be read in units of 4 bytes. -The file can only be used in non-blocking mode \- even +The file can only be used in nonblocking mode \- even .BR poll (2) cannot be used to block on this file. The only possible operation on an open @@ -679,7 +679,7 @@ If the file is opened in blocking mode (i.e., without .BR O_NONBLOCK ), then the read will block until a DMA tag (as performed by a previous write) is complete. -In non-blocking mode, +In nonblocking mode, the MFC tag status register will be returned without waiting. .TP .BR poll (2)