From 7fac88a949c7fdf554cc048bd9b47059830ebb68 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sun, 21 Oct 2012 08:04:42 +0200 Subject: [PATCH] eventfd.2, futex.2, mmap2.2, open.2, pciconfig_read.2, ptrace.2, reboot.2, request_key.2, sched_rr_get_interval.2, splice.2, stat.2, sync_file_range.2, syscalls.2, timer_create.2, vm86.2, pthread_attr_setscope.3, core.5, proc.5, aio.7, futex.7, netlink.7, time.7: Global fix: "userspace" ==> "user space" or "user-space" Existing pages variously use "userspace or "user space". But, "userspace" is not quite an English word. So change "userspace" to "user space" or, when used attributively, "user-space". Signed-off-by: Michael Kerrisk --- man2/eventfd.2 | 6 +++--- man2/futex.2 | 8 ++++---- man2/mmap2.2 | 2 +- man2/open.2 | 4 ++-- man2/pciconfig_read.2 | 2 +- man2/ptrace.2 | 8 ++++---- man2/reboot.2 | 2 +- man2/request_key.2 | 2 +- man2/sched_rr_get_interval.2 | 2 +- man2/splice.2 | 2 +- man2/stat.2 | 2 +- man2/sync_file_range.2 | 2 +- man2/syscalls.2 | 2 +- man2/timer_create.2 | 4 ++-- man2/vm86.2 | 2 +- man3/pthread_attr_setscope.3 | 2 +- man5/core.5 | 2 +- man5/proc.5 | 2 +- man7/aio.7 | 2 +- man7/futex.7 | 14 +++++++------- man7/netlink.7 | 18 +++++++++--------- man7/time.7 | 2 +- 22 files changed, 46 insertions(+), 46 deletions(-) diff --git a/man2/eventfd.2 b/man2/eventfd.2 index 0bda2758f..773bcd838 100644 --- a/man2/eventfd.2 +++ b/man2/eventfd.2 @@ -28,8 +28,8 @@ eventfd \- create a file descriptor for event notification .SH DESCRIPTION .BR eventfd () creates an "eventfd object" that can be used as -an event wait/notify mechanism by userspace applications, -and by the kernel to notify userspace applications of events. +an event wait/notify mechanism by user-space applications, +and by the kernel to notify user-space applications of events. The object contains an unsigned 64-bit integer .RI ( uint64_t ) counter that is maintained by the kernel. @@ -278,7 +278,7 @@ and only one file descriptor is required (versus the two required for a pipe). When used in the kernel, an eventfd -file descriptor can provide a kernel-userspace bridge allowing, +file descriptor can provide a bridge from kernel to user space, allowing, for example, functionalities like KAIO (kernel AIO) .\" or eventually syslets/threadlets to signal to a file descriptor that some operation is complete. diff --git a/man2/futex.2 b/man2/futex.2 index fe69f2d4e..29c78df6b 100644 --- a/man2/futex.2 +++ b/man2/futex.2 @@ -16,7 +16,7 @@ .\" .TH FUTEX 2 2012-08-13 "Linux" "Linux Programmer's Manual" .SH NAME -futex \- Fast Userspace Locking system call +futex \- Fast User-Space Locking system call .SH SYNOPSIS .nf .sp @@ -48,7 +48,7 @@ described in .PP When a .BR futex (7) -operation did not finish uncontended in userspace, a call needs to be made +operation did not finish uncontended in user space, a call needs to be made to the kernel to arbitrate. Arbitration can either mean putting the calling process to sleep or, conversely, waking a waiting process. @@ -214,7 +214,7 @@ now.) .B EFAULT Error retrieving .I timeout -information from userspace. +information from user space. .TP .B EINTR A @@ -265,7 +265,7 @@ To reiterate, bare futexes are not intended as an easy-to-use abstraction for end-users. (There is no wrapper function for this system call in glibc.) Implementors are expected to be assembly literate and to have -read the sources of the futex userspace library referenced below. +read the sources of the futex user-space library referenced below. .\" .SH "AUTHORS" .\" .PP .\" Futexes were designed and worked on by diff --git a/man2/mmap2.2 b/man2/mmap2.2 index d13b7186c..1749b3bcb 100644 --- a/man2/mmap2.2 +++ b/man2/mmap2.2 @@ -61,7 +61,7 @@ is set appropriately. .SH ERRORS .TP .B EFAULT -Problem with getting the data from userspace. +Problem with getting the data from user space. .TP .B EINVAL (Various platforms where the page size is not 4096 bytes.) diff --git a/man2/open.2 b/man2/open.2 index ad318b195..f9a63e986 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -703,7 +703,7 @@ to the same numerical value as Most Linux file systems don't actually implement the POSIX .B O_SYNC semantics, which require all metadata updates of a write -to be on disk on returning to userspace, but only the +to be on disk on returning to user space, but only the .B O_DSYNC semantics, which require only actual file data and metadata necessary to retrieve it to be on disk by the time the system call returns. @@ -752,7 +752,7 @@ flag, its st_ctime and st_mtime fields are set to the current time. The .B O_DIRECT flag may impose alignment restrictions on the length and address -of userspace buffers and the file offset of I/Os. +of user-space buffers and the file offset of I/Os. In Linux alignment restrictions vary by file system and kernel version and might be absent entirely. diff --git a/man2/pciconfig_read.2 b/man2/pciconfig_read.2 index a4163e59d..b9949b275 100644 --- a/man2/pciconfig_read.2 +++ b/man2/pciconfig_read.2 @@ -20,7 +20,7 @@ pciconfig_read, pciconfig_write, pciconfig_iobase \- pci device information hand .PP Most of the interaction with PCI devices is already handled by the kernel PCI layer, -and thus these calls should not normally need to be accessed from userspace. +and thus these calls should not normally need to be accessed from user space. .TP .BR pciconfig_read () Reads to diff --git a/man2/ptrace.2 b/man2/ptrace.2 index c45e569a5..9580604a1 100644 --- a/man2/ptrace.2 +++ b/man2/ptrace.2 @@ -210,7 +210,7 @@ the offset must typically be word-aligned. In order to maintain the integrity of the kernel, some modifications to the USER area are disallowed. .\" FIXME In the preceding sentence, which modifications are disallowed, -.\" and when they are disallowed, how does userspace discover that fact? +.\" and when they are disallowed, how does user space discover that fact? .TP .BR PTRACE_GETREGS ", " PTRACE_GETFPREGS Copy the tracee's general-purpose or floating-point registers, @@ -252,7 +252,7 @@ As for .BR PTRACE_POKEUSER , some general-purpose register modifications may be disallowed. .\" FIXME In the preceding sentence, which modifications are disallowed, -.\" and when they are disallowed, how does userspace discover that fact? +.\" and when they are disallowed, how does user space discover that fact? .RI ( addr is ignored.) Note that SPARC systems have the meaning of @@ -1125,7 +1125,7 @@ for the following cases: .TP .IR si_code " <= 0" .B SIGTRAP -was delivered as a result of a userspace action, +was delivered as a result of a user-space action, for example, a system call .RB ( tgkill (2), .BR kill (2), @@ -1781,7 +1781,7 @@ before has attached to it. Attaching caused .BR epoll_wait (2) -to return to userspace with the error +to return to user space with the error .BR EINTR . In this particular case, the program reacted to .B EINTR diff --git a/man2/reboot.2 b/man2/reboot.2 index 7e63d1853..18524a406 100644 --- a/man2/reboot.2 +++ b/man2/reboot.2 @@ -161,7 +161,7 @@ is set appropriately. .SH ERRORS .TP .B EFAULT -Problem with getting userspace data under +Problem with getting user-space data under .BR LINUX_REBOOT_CMD_RESTART2 . .TP .B EINVAL diff --git a/man2/request_key.2 b/man2/request_key.2 index 5e7fc8547..b4dad3290 100644 --- a/man2/request_key.2 +++ b/man2/request_key.2 @@ -54,7 +54,7 @@ If the key is not found then, if is set, this function will attempt to look further afield. In such a case, the .I callout_info -is passed to a userspace service such as +is passed to a user-space service such as .B /sbin/request\-key to generate the key. .P diff --git a/man2/sched_rr_get_interval.2 b/man2/sched_rr_get_interval.2 index 9169810db..944d13da7 100644 --- a/man2/sched_rr_get_interval.2 +++ b/man2/sched_rr_get_interval.2 @@ -81,7 +81,7 @@ is set appropriately. .SH ERRORS .TP .B EFAULT -Problem with copying information to userspace. +Problem with copying information to user space. .TP .B EINVAL Invalid pid. diff --git a/man2/splice.2 b/man2/splice.2 index 4590e2606..244733fdd 100644 --- a/man2/splice.2 +++ b/man2/splice.2 @@ -175,7 +175,7 @@ The three system calls .BR vmsplice (2), and .BR tee (2), -provide userspace programs with full control over an arbitrary +provide user-space programs with full control over an arbitrary kernel buffer, implemented within the kernel using the same type of buffer that is used for a pipe. In overview, these system calls perform the following tasks: diff --git a/man2/stat.2 b/man2/stat.2 index 0b82e1db3..d4838a2e9 100644 --- a/man2/stat.2 +++ b/man2/stat.2 @@ -460,7 +460,7 @@ T} 9000 S_IFNWK n 110000 network special (HP-UX) a000 S_IFLNK l@ 120000 symbolic link (BSD) b000 S_IFSHAD 130000 T{ -Solaris shadow inode for ACL (not seen by userspace) +Solaris shadow inode for ACL (not seen by user space) T} c000 S_IFSOCK s= 140000 socket (BSD; also "S_IFSOC" on VxFS) d000 S_IFDOOR D> 150000 Solaris door diff --git a/man2/sync_file_range.2 b/man2/sync_file_range.2 index 5c1781293..82ed87898 100644 --- a/man2/sync_file_range.2 +++ b/man2/sync_file_range.2 @@ -172,7 +172,7 @@ Out of disk space. refers to something other than a regular file, a block device, a directory, or a symbolic link. .\" FIXME . (bug?) Actually, how can 'fd' refer to a symbolic link (S_ISLNK)? -.\" (In userspace at least) it isn't possible to obtain a file descriptor +.\" (In user space at least) it isn't possible to obtain a file descriptor .\" for a symbolic link. .SH VERSIONS .BR sync_file_range () diff --git a/man2/syscalls.2 b/man2/syscalls.2 index b9abf394e..4bc23b7f7 100644 --- a/man2/syscalls.2 +++ b/man2/syscalls.2 @@ -624,7 +624,7 @@ and may never be in the standard kernel. There was briefly .BR set_zone_reclaim (2), added in Linux 2.6.13, and removed in 2.6.16; -this system call was never available to userspace. +this system call was never available to user space. .SH NOTES .PP Roughly speaking, the code belonging to the system call diff --git a/man2/timer_create.2 b/man2/timer_create.2 index 7e08911b9..0d6360253 100644 --- a/man2/timer_create.2 +++ b/man2/timer_create.2 @@ -238,12 +238,12 @@ is implemented within glibc, rather than the kernel. The timer IDs presented at user level are maintained by glibc, which maps these IDs to the timer IDs employed by the kernel. .\" See the glibc source file kernel-posix-timers.h for the structure -.\" that glibc uses to map userspace timer IDs to kernel timer IDs +.\" that glibc uses to map user-space timer IDs to kernel timer IDs .\" The kernel-level timer ID is exposed via siginfo.si_tid. .PP The POSIX timers system calls first appeared in Linux 2.6. Prior to this, -glibc provided an incomplete userspace implementation +glibc provided an incomplete user-space implementation .RB ( CLOCK_REALTIME timers only) using POSIX threads, and current glibc falls back to this implementation on systems diff --git a/man2/vm86.2 b/man2/vm86.2 index 49fb5e796..b66cad3db 100644 --- a/man2/vm86.2 +++ b/man2/vm86.2 @@ -58,7 +58,7 @@ is set appropriately. .TP .B EFAULT This return value is specific to i386 and indicates a problem with getting -userspace data. +user-space data. .TP .B ENOSYS This return value indicates the call is not implemented on the present diff --git a/man3/pthread_attr_setscope.3 b/man3/pthread_attr_setscope.3 index 393bb53c6..b13fee967 100644 --- a/man3/pthread_attr_setscope.3 +++ b/man3/pthread_attr_setscope.3 @@ -107,7 +107,7 @@ POSIX.1-2001. .SH NOTES The .B PTHREAD_SCOPE_SYSTEM -contention scope typically indicates that a userspace thread is +contention scope typically indicates that a user-space thread is bound directly to a single kernel-scheduling entity. This is the case on Linux for the obsolete LinuxThreads implementation and the modern NPTL implementation, diff --git a/man5/core.5 b/man5/core.5 index 7beea7b26..379082d91 100644 --- a/man5/core.5 +++ b/man5/core.5 @@ -302,7 +302,7 @@ where each thread of a process has a different PID.) .\" threads in a process share the same PID (as POSIX.1 requires). .\" Probably the behavior is maintained so that applications using .\" LinuxThreads continue appending the PID (the kernel has no easy -.\" way of telling which threading implementation the userspace +.\" way of telling which threading implementation the user-space .\" application is using). -- mtk, April 2006 .SH EXAMPLE The program below can be used to demonstrate the use of the diff --git a/man5/proc.5 b/man5/proc.5 index e3a942f0e..8f7b60dba 100644 --- a/man5/proc.5 +++ b/man5/proc.5 @@ -1604,7 +1604,7 @@ Largest contiguous block of vmalloc area which is free. .TP .IR AnonHugePages " %lu (since Linux 2.6.38)" (\fBCONFIG_TRANSPARENT_HUGEPAGE\fP is required.) -Non-file backed huge pages mapped into userspace page tables. +Non-file backed huge pages mapped into user-space page tables. .TP .IR HugePages_Total " %lu" (\fBCONFIG_HUGETLB_PAGE\fP is required.) diff --git a/man7/aio.7 b/man7/aio.7 index 13202a1d1..537dbb0e8 100644 --- a/man7/aio.7 +++ b/man7/aio.7 @@ -160,7 +160,7 @@ Simultaneous asynchronous read or write operations using the same .I aiocb structure yield undefined results. -The current Linux POSIX AIO implementation is provided in userspace by glibc. +The current Linux POSIX AIO implementation is provided in user space by glibc. This has a number of limitations, most notably that maintaining multiple threads to perform I/O operations is expensive and scales poorly. Work has been in progress for some time on a kernel diff --git a/man7/futex.7 b/man7/futex.7 index 367f732cf..dd8d20b2a 100644 --- a/man7/futex.7 +++ b/man7/futex.7 @@ -7,15 +7,15 @@ .\" etc. to Steve Cheng . .TH FUTEX 7 2012-08-05 "Linux" "Linux Programmer's Manual" .SH NAME -futex \- Fast Userspace Locking +futex \- Fast User-Space Locking .SH SYNOPSIS .nf .B #include .fi .SH DESCRIPTION .PP -The Linux kernel provides futexes ("Fast Userspace muTexes") -as a building block for fast userspace +The Linux kernel provides futexes ("Fast user-space mutexes") +as a building block for fast user-space locking and semaphores. Futexes are very basic and lend themselves well for building higher level locking abstractions such as POSIX mutexes. @@ -34,7 +34,7 @@ In its bare form, a futex has semaphore semantics; it is a counter that can be incremented and decremented atomically; processes can wait for the value to become positive. .PP -Futex operation is entirely userspace for the noncontended case. +Futex operation is entirely user space for the noncontended case. The kernel is only involved to arbitrate the contended case. As any sane design will strive for noncontention, futexes are also optimized for this situation. @@ -47,7 +47,7 @@ via shared memory segments or because they share memory space, in which case the application is commonly called multithreaded. .SS "Semantics" .PP -Any futex operation starts in userspace, +Any futex operation starts in user space, but it may necessary to communicate with the kernel using the .BR futex (2) system call. @@ -61,7 +61,7 @@ This is the noncontended case which is fast and should be common. In the contended case, the atomic increment changed the counter from \-1 (or some other negative number). If this is detected, there are waiters. -Userspace should now set the counter to 1 and instruct the +User space should now set the counter to 1 and instruct the kernel to wake up any waiters using the .B FUTEX_WAKE operation. @@ -96,7 +96,7 @@ Current semantics are available from Linux 2.5.40 onward. To reiterate, bare futexes are not intended as an easy to use abstraction for end-users. Implementors are expected to be assembly literate and to have read -the sources of the futex userspace library referenced +the sources of the futex user-space library referenced below. .PP This man page illustrates the most common use of the diff --git a/man7/netlink.7 b/man7/netlink.7 index dfdba9a50..3d499e34f 100644 --- a/man7/netlink.7 +++ b/man7/netlink.7 @@ -6,7 +6,7 @@ .\" $Id: netlink.7,v 1.8 2000/06/22 13:23:00 ak Exp $ .TH NETLINK 7 2012-08-05 "Linux" "Linux Programmer's Manual" .SH NAME -netlink \- Communication between kernel and userspace (AF_NETLINK) +netlink \- Communication between kernel and user space (AF_NETLINK) .SH SYNOPSIS .nf .B #include @@ -17,8 +17,8 @@ netlink \- Communication between kernel and userspace (AF_NETLINK) .fi .SH DESCRIPTION Netlink is used to transfer information between kernel and -userspace processes. -It consists of a standard sockets-based interface for userspace +user-space processes. +It consists of a standard sockets-based interface for user space processes and an internal kernel API for kernel modules. The internal kernel interface is not documented in this manual page. There is also an obsolete netlink interface @@ -53,7 +53,7 @@ Messages from 1-wire subsystem. Reserved for user-mode socket protocols. .TP .B NETLINK_FIREWALL -Transport IPv4 packets from netfilter to userspace. +Transport IPv4 packets from netfilter to user space. Used by .I ip_queue kernel module. @@ -82,7 +82,7 @@ Auditing. .TP .B NETLINK_FIB_LOOKUP .\" FIXME More details on NETLINK_FIB_LOOKUP needed. -Access to FIB lookup from userspace. +Access to FIB lookup from user space. .TP .B NETLINK_CONNECTOR Kernel connector. @@ -95,7 +95,7 @@ in the Linux kernel source tree for further information. Netfilter subsystem. .TP .B NETLINK_IP6_FW -Transport IPv6 packets from netfilter to userspace. +Transport IPv6 packets from netfilter to user space. Used by .I ip6_queue kernel module. @@ -105,7 +105,7 @@ DECnet routing messages. .TP .B NETLINK_KOBJECT_UEVENT .\" FIXME More details on NETLINK_KOBJECT_UEVENT needed. -Kernel messages to userspace. +Kernel messages to user space. .TP .B NETLINK_GENERIC Generic netlink family for simplified netlink usage. @@ -268,7 +268,7 @@ A user process should follow this convention too. However, reliable transmissions from kernel to user are impossible in any case. The kernel can't send a netlink message if the socket buffer is full: -the message will be dropped and the kernel and the userspace process will +the message will be dropped and the kernel and the user-space process will no longer have the same view of kernel state. It is up to the application to detect when this happens (via the .B ENOBUFS @@ -300,7 +300,7 @@ struct sockaddr_nl { .I nl_pid is the unicast address of netlink socket. It's always 0 if the destination is in the kernel. -For a userspace process, +For a user-space process, .I nl_pid is usually the PID of the process owning the destination socket. However, diff --git a/man7/time.7 b/man7/time.7 index 5f08213ee..764228430 100644 --- a/man7/time.7 +++ b/man7/time.7 @@ -97,7 +97,7 @@ The system call is a special case. It reports times with a granularity defined by the kernel constant .IR USER_HZ . -Userspace applications can determine the value of this constant using +User-space applications can determine the value of this constant using .IR sysconf(_SC_CLK_TCK) . .\" glibc gets this info with a little help from the ELF loader; .\" see glibc elf/dl-support.c and kernel fs/binfmt_elf.c.