From 75b48e9d74192cc7e6203662017568c739b8771d Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sun, 17 Dec 2006 01:34:44 +0000 Subject: [PATCH] Various fixes to CONFORMING TO --- man2/accept.2 | 4 ++-- man2/access.2 | 2 +- man2/bind.2 | 2 +- man2/clone.2 | 2 +- man2/connect.2 | 4 ++-- man2/dup.2 | 2 +- man2/epoll_create.2 | 4 ++-- man2/epoll_ctl.2 | 4 ++-- man2/epoll_wait.2 | 4 ++-- man2/fcntl.2 | 2 +- man2/idle.2 | 2 +- man2/io_destroy.2 | 3 ++- man2/io_getevents.2 | 6 ++++-- man2/io_submit.2 | 6 ++++-- man2/llseek.2 | 2 +- man2/lookup_dcookie.2 | 2 +- man2/modify_ldt.2 | 2 +- man2/mount.2 | 2 +- man2/mremap.2 | 2 +- man2/nfsservctl.2 | 2 +- man2/open.2 | 2 +- man2/personality.2 | 3 ++- man2/pivot_root.2 | 2 +- man2/posix_fadvise.2 | 2 +- man2/prctl.2 | 2 +- man2/statfs.2 | 1 + man2/statvfs.2 | 2 +- man2/sysctl.2 | 2 +- man2/sysinfo.2 | 2 +- man2/unshare.2 | 2 +- man2/vhangup.2 | 2 +- man2/wait.2 | 2 +- 32 files changed, 45 insertions(+), 38 deletions(-) diff --git a/man2/accept.2 b/man2/accept.2 index fef28427d..b7bdccabc 100644 --- a/man2/accept.2 +++ b/man2/accept.2 @@ -245,9 +245,9 @@ The value .B ERESTARTSYS may be seen during a trace. .SH "CONFORMING TO" -SVr4, 4.4BSD +SVr4, 4.4BSD, .RB ( accept () -first appeared in 4.2BSD). +first appeared in 4.2BSD), POSIX.1-2001. .\" The BSD man page documents five possible error returns .\" (EBADF, ENOTSOCK, EOPNOTSUPP, EWOULDBLOCK, EFAULT). .\" POSIX.1-2001 documents errors diff --git a/man2/access.2 b/man2/access.2 index 3d56a24e7..f4d2bd952 100644 --- a/man2/access.2 +++ b/man2/access.2 @@ -171,7 +171,7 @@ doing so using creates a security hole, because the user might exploit the short time interval between checking and opening the file to manipulate it. .SH "CONFORMING TO" -SVr4, POSIX.1-2001, 4.3BSD +SVr4, 4.3BSD, POSIX.1-2001. .SH "SEE ALSO" .BR chmod (2), .BR chown (2), diff --git a/man2/bind.2 b/man2/bind.2 index 3089c39a7..6923fa740 100644 --- a/man2/bind.2 +++ b/man2/bind.2 @@ -258,7 +258,7 @@ The socket inode would reside on a read-only file system. .SH BUGS The transparent proxy options are not described. .SH "CONFORMING TO" -SVr4, 4.4BSD (the +SVr4, 4.4BSD, POSIX.1-2001 (the .BR bind () function first appeared in 4.2BSD). .\" SVr4 documents an additional diff --git a/man2/clone.2 b/man2/clone.2 index e6bfd3a4d..bd653af3c 100644 --- a/man2/clone.2 +++ b/man2/clone.2 @@ -668,7 +668,7 @@ The .BR clone () and .B sys_clone -calls are Linux-specific and should not be used in programs +calls are Linux specific and should not be used in programs intended to be portable. .SH BUGS Versions of the GNU C library that include the NPTL threading library diff --git a/man2/connect.2 b/man2/connect.2 index f55e315be..d4640b2cc 100644 --- a/man2/connect.2 +++ b/man2/connect.2 @@ -211,9 +211,9 @@ Timeout while attempting connection. The server may be too busy to accept new connections. Note that for IP sockets the timeout may be very long when syncookies are enabled on the server. .SH "CONFORMING TO" -SVr4, 4.4BSD (the +SVr4, 4.4BSD, (the .BR connect () -function first appeared in 4.2BSD). +function first appeared in 4.2BSD), POSIX.1-2001. .\" SVr4 documents the additional .\" general error codes .\" .BR EADDRNOTAVAIL , diff --git a/man2/dup.2 b/man2/dup.2 index a16fe7376..295b0dfcf 100644 --- a/man2/dup.2 +++ b/man2/dup.2 @@ -127,7 +127,7 @@ first. SVr4, 4.3BSD, POSIX.1-2001. .\" SVr4 documents additional .\" EINTR and ENOLINK error conditions. POSIX.1 adds EINTR. -.\" The EBUSY return is Linux-specific. +.\" The EBUSY return is Linux specific. .SH "SEE ALSO" .BR close (2), .BR fcntl (2), diff --git a/man2/epoll_create.2 b/man2/epoll_create.2 index 77e29327c..5ee9fb5e0 100644 --- a/man2/epoll_create.2 +++ b/man2/epoll_create.2 @@ -67,8 +67,8 @@ The system limit on the total number of open files has been reached. There was insufficient memory to create the kernel object. .SH CONFORMING TO .BR epoll_create (2) -is a new API introduced in Linux kernel 2.5.44. -The interface should be finalized by Linux kernel 2.5.66. +is Linux specific, and was introduced in kernel 2.5.44. +.\" The interface should be finalized by Linux kernel 2.5.66. .SH "SEE ALSO" .BR close (2), .BR epoll_ctl (2), diff --git a/man2/epoll_ctl.2 b/man2/epoll_ctl.2 index 543630c75..c762e7936 100644 --- a/man2/epoll_ctl.2 +++ b/man2/epoll_ctl.2 @@ -209,8 +209,8 @@ does not support .BR epoll . .SH CONFORMING TO .BR epoll_ctl (2) -is a new API introduced in Linux kernel 2.5.44. -The interface should be finalized by Linux kernel 2.5.66. +is Linux specific, and was introduced in kernel 2.5.44. +.\" The interface should be finalized by Linux kernel 2.5.66. .SH BUGS In kernel versions before 2.6.9, the .B EPOLL_CTL_DEL diff --git a/man2/epoll_wait.2 b/man2/epoll_wait.2 index 19e2a34ec..bddf6eae7 100644 --- a/man2/epoll_wait.2 +++ b/man2/epoll_wait.2 @@ -123,8 +123,8 @@ file descriptor, or is less than or equal to zero. .SH CONFORMING TO .BR epoll_wait (2) -is a new API introduced in Linux kernel 2.5.44. -The interface should be finalized by Linux kernel 2.5.66. +is Linux specific, and was introduced in kernel 2.5.44. +.\" The interface should be finalized by Linux kernel 2.5.66. .SH "SEE ALSO" .BR epoll_create (2), .BR epoll_ctl (2), diff --git a/man2/fcntl.2 b/man2/fcntl.2 index 5d0ef44d8..34f00af88 100644 --- a/man2/fcntl.2 +++ b/man2/fcntl.2 @@ -557,7 +557,7 @@ is specific to BSD and Linux. .B F_GETSIG and .B F_SETSIG -are Linux-specific. POSIX has asynchronous I/O and the +are Linux specific. POSIX has asynchronous I/O and the .I aio_sigevent structure to achieve similar things; these are also available in Linux as part of the GNU C Library (Glibc). diff --git a/man2/idle.2 b/man2/idle.2 index 9bba66838..9fa4b9f5d 100644 --- a/man2/idle.2 +++ b/man2/idle.2 @@ -57,7 +57,7 @@ never returns for process 0, and always returns \-1 for a user process. .B EPERM Always, for a user process. .SH "CONFORMING TO" -This function is Linux-specific, and should not be used in programs +This function is Linux specific, and should not be used in programs intended to be portable. .SH NOTES Since 2.3.13 this system call does not exist anymore. diff --git a/man2/io_destroy.2 b/man2/io_destroy.2 index b581a3241..d4f5063f1 100644 --- a/man2/io_destroy.2 +++ b/man2/io_destroy.2 @@ -76,7 +76,8 @@ The asynchronous I/O system calls first appeared in Linux 2.5, August 2002. .SH "SEE ALSO" .PP -\fBio_setup\fR(2), \fBio_submit\fR(2), \fBio_getevents\fR(2), \fBio_cancel\fR(2). +\fBio_setup\fR(2), \fBio_submit\fR(2), \fBio_getevents\fR(2), +\fBio_cancel\fR(2). .SH "NOTES" diff --git a/man2/io_getevents.2 b/man2/io_getevents.2 index 61be40cbb..4b4c9e60b 100644 --- a/man2/io_getevents.2 +++ b/man2/io_getevents.2 @@ -75,7 +75,8 @@ ENOSYS .SH "CONFORMING TO" .PP -\fBio_getevents\fR() is Linux specific and should not be used in programs that are intended to be portable. +\fBio_getevents\fR() is Linux specific and should not be used in +programs that are intended to be portable. .SH "VERSIONS" @@ -85,7 +86,8 @@ The asynchronous I/O system calls first appeared in Linux 2.5, August 2002. .SH "SEE ALSO" .PP -\fBio_setup\fR(2), \fBio_submit\fR(2), \fBio_getevents\fR(2), \fBio_cancel\fR(2), \fBio_destroy\fR(2). +\fBio_setup\fR(2), \fBio_submit\fR(2), \fBio_getevents\fR(2), +\fBio_cancel\fR(2), \fBio_destroy\fR(2). .SH "NOTES" diff --git a/man2/io_submit.2 b/man2/io_submit.2 index 272eeac81..3bb85beee 100644 --- a/man2/io_submit.2 +++ b/man2/io_submit.2 @@ -75,7 +75,8 @@ ENOSYS .SH "CONFORMING TO" .PP -\fBio_submit\fR() is Linux specific and should not be used in programs that are intended to be portable. +\fBio_submit\fR() is Linux specific and should not be used in +programs that are intended to be portable. .SH "VERSIONS" @@ -85,7 +86,8 @@ The asynchronous I/O system calls first appeared in Linux 2.5, August 2002. .SH "SEE ALSO" .PP -\fBio_setup\fR(2), \fBio_destroy\fR(2), \fBio_getevents\fR(2), \fBio_cancel\fR(2). +\fBio_setup\fR(2), \fBio_destroy\fR(2), \fBio_getevents\fR(2), +\fBio_cancel\fR(2). .SH "NOTES" diff --git a/man2/llseek.2 b/man2/llseek.2 index 41016ea95..73fd77603 100644 --- a/man2/llseek.2 +++ b/man2/llseek.2 @@ -83,7 +83,7 @@ Problem with copying results to user space. .I whence is invalid. .SH "CONFORMING TO" -This function is Linux-specific, and should not be used in programs +This function is Linux specific, and should not be used in programs intended to be portable. .SH "SEE ALSO" .BR lseek (2), diff --git a/man2/lookup_dcookie.2 b/man2/lookup_dcookie.2 index a4a18e50e..aa8ca4df8 100644 --- a/man2/lookup_dcookie.2 +++ b/man2/lookup_dcookie.2 @@ -83,7 +83,7 @@ required to look up cookie values. The buffer was not large enough to hold the path of the directory entry. .SH "CONFORMING TO" .BR lookup_dcookie () -is Linux-specific. +is Linux specific. .SH AVAILABILITY Since Linux 2.5.43. The ENAMETOOLONG error return was added in 2.5.70. diff --git a/man2/modify_ldt.2 b/man2/modify_ldt.2 index 7b1f73c38..be0c07dfc 100644 --- a/man2/modify_ldt.2 +++ b/man2/modify_ldt.2 @@ -104,7 +104,7 @@ is 1 and the new ldt entry has invalid values. .I func is neither 0 nor 1. .SH "CONFORMING TO" -This call is Linux-specific and should not be used in programs intended +This call is Linux specific and should not be used in programs intended to be portable. .SH "SEE ALSO" .BR vm86 (2) diff --git a/man2/mount.2 b/man2/mount.2 index 38bc312d5..729feec15 100644 --- a/man2/mount.2 +++ b/man2/mount.2 @@ -367,7 +367,7 @@ is out of range. .B EPERM The caller does not have the required privileges. .SH "CONFORMING TO" -These functions are Linux-specific and should not be used in +These functions are Linux specific and should not be used in programs intended to be portable. .SH HISTORY The original diff --git a/man2/mremap.2 b/man2/mremap.2 index b3cc4a079..6fbf6a204 100644 --- a/man2/mremap.2 +++ b/man2/mremap.2 @@ -170,7 +170,7 @@ did not allow for the .I new_address argument. .SH "CONFORMING TO" -This call is Linux-specific, and should not be used in programs +This call is Linux specific, and should not be used in programs intended to be portable. 4.2BSD had a (never actually implemented) .BR mremap (2) call with completely different semantics. diff --git a/man2/nfsservctl.2 b/man2/nfsservctl.2 index f9e58b5bf..95e00ec97 100644 --- a/man2/nfsservctl.2 +++ b/man2/nfsservctl.2 @@ -44,4 +44,4 @@ On success, zero is returned. On error, \-1 is returned, and .I errno is set appropriately. .SH "CONFORMING TO" -This call is Linux-specific. +This call is Linux specific. diff --git a/man2/open.2 b/man2/open.2 index e36fcb624..a4f4e0248 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -498,7 +498,7 @@ The .BR O_NOFOLLOW , and .B O_DIRECTORY -flags are Linux-specific. +flags are Linux specific. One may have to define the .B _GNU_SOURCE macro to get their definitions. diff --git a/man2/personality.2 b/man2/personality.2 index 6cf34aefd..2643dc0f2 100644 --- a/man2/personality.2 +++ b/man2/personality.2 @@ -61,4 +61,5 @@ is set appropriately. The kernel was unable to change the personality. .SH "CONFORMING TO" .BR personality () -is Linux-specific and should not be used in programs intended to be portable. +is Linux specific and should not be used in programs intended to +be portable. diff --git a/man2/pivot_root.2 b/man2/pivot_root.2 index d98a4f4c7..df2b4402c 100644 --- a/man2/pivot_root.2 +++ b/man2/pivot_root.2 @@ -103,7 +103,7 @@ processes in the system. Some of the more obscure uses of \fBpivot_root\fP() may quickly lead to insanity. .SH "CONFORMING TO" -\fBpivot_root\fP() is Linux-specific and hence is not portable. +\fBpivot_root\fP() is Linux specific and hence is not portable. .SH HISTORY \fBpivot_root\fP() was introduced in Linux 2.3.41. .SH "SEE ALSO" diff --git a/man2/posix_fadvise.2 b/man2/posix_fadvise.2 index 65444dd06..79093f11e 100644 --- a/man2/posix_fadvise.2 +++ b/man2/posix_fadvise.2 @@ -119,7 +119,7 @@ parameter was changed from .I size_t to .I off_t -in POSIX.1-2003 TC5. +in POSIX.1-2003 TC1. .SH BUGS In kernels before 2.6.6, if .I len diff --git a/man2/prctl.2 b/man2/prctl.2 index 985c26a18..ce34a52cb 100644 --- a/man2/prctl.2 +++ b/man2/prctl.2 @@ -202,7 +202,7 @@ and .I arg2 is not zero or a signal number. .SH "CONFORMING TO" -This call is Linux-specific. +This call is Linux specific. IRIX has a .BR prctl () system call (also introduced in Linux 2.1.44 diff --git a/man2/statfs.2 b/man2/statfs.2 index ff0594d3b..c7d63cbe4 100644 --- a/man2/statfs.2 +++ b/man2/statfs.2 @@ -176,6 +176,7 @@ is not a directory. Some values were too large to be represented in the returned struct. .PP .SH "CONFORMING TO" +Linux specific. The Linux .BR statfs () was inspired by the 4.4BSD one diff --git a/man2/statvfs.2 b/man2/statvfs.2 index f885f9d6d..2cafa62f5 100644 --- a/man2/statvfs.2 +++ b/man2/statvfs.2 @@ -152,7 +152,7 @@ is not a directory. Some values were too large to be represented in the returned struct. .PP .SH "CONFORMING TO" -Solaris, Irix, POSIX.1-2001 +POSIX.1-2001 .SH NOTES The Linux kernel has system calls .BR statfs () diff --git a/man2/sysctl.2 b/man2/sysctl.2 index d2ac26795..f9c06d089 100644 --- a/man2/sysctl.2 +++ b/man2/sysctl.2 @@ -124,7 +124,7 @@ was non-zero, or no write permission where .I newval was non-zero. .SH "CONFORMING TO" -This call is Linux-specific, and should not be used in programs +This call is Linux specific, and should not be used in programs intended to be portable. A .BR sysctl () diff --git a/man2/sysinfo.2 b/man2/sysinfo.2 index e798ba7fb..a827c11b3 100644 --- a/man2/sysinfo.2 +++ b/man2/sysinfo.2 @@ -79,7 +79,7 @@ is set appropriately. .B EFAULT pointer to \fIstruct\ sysinfo\fP is invalid .SH "CONFORMING TO" -This function is Linux-specific, and should not be used in programs +This function is Linux specific, and should not be used in programs intended to be portable. .sp The Linux kernel has a diff --git a/man2/unshare.2 b/man2/unshare.2 index 52504892e..bf8557173 100644 --- a/man2/unshare.2 +++ b/man2/unshare.2 @@ -138,7 +138,7 @@ An invalid bit was specified in .SH CONFORMING TO The .BR unshare () -system call is Linux-specific. +system call is Linux specific. .SH NOTES The .BR unshare () diff --git a/man2/vhangup.2 b/man2/vhangup.2 index 6e24815c7..38b417376 100644 --- a/man2/vhangup.2 +++ b/man2/vhangup.2 @@ -48,7 +48,7 @@ the .B CAP_SYS_TTY_CONFIG capability is required. .SH "CONFORMING TO" -This call is Linux-specific, and should not be used in programs +This call is Linux specific, and should not be used in programs intended to be portable. .SH "SEE ALSO" .BR capabilities (7), diff --git a/man2/wait.2 b/man2/wait.2 index a8479cd6e..3bce599ad 100644 --- a/man2/wait.2 +++ b/man2/wait.2 @@ -459,7 +459,7 @@ However, POSIX prescribes such functionality, and since Linux 2.4 a thread can, and by default will, wait on children of other threads in the same thread group. .LP -The following Linux-specific +The following Linux specific .I options are for use with children created using .BR clone (2);