LDP
/
man-pages
mirror of https://github.com/mkerrisk/man-pages
0
1
Fork 0
Code Releases Activity

Reformatted FIXMEs

This commit is contained in:
Michael Kerrisk 2006-02-10 18:46:42 +00:00
parent bf53d187ba
commit c533af9d27
15 changed files with 99 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Changes
View File

@ -8,12 +8,31 @@ Contributors
The following people contributed notes, ideas, or patches that have
been incorporated in changes in this release:
Luc Van Oostenryck <lkml@looxix.net>
Samuel Thibault <samuel.thibault@ens-lyon.org>
Apologies if I missed anyone!
Global changes
--------------
stpncpy.3
strstr.3
strcmp.3
toupper.3
strlen.3
stpcpy.3
puts.3
strdup.3
strtok.3
isalpha.3
strspn.3
gets.3
strpbrk.3
mtk after a suggestion from Samuel Thibault
Added SEE ALSO pointers to wide character equivalent functions
See Debian bug 351996
Typographical or grammatical errors have been corrected in several
places.
@ -21,6 +40,16 @@ places.
New pages
---------
get_kernel_syms.2
create_module.2
delete_module.2
init_module.2
query_module.2
FSF / mtk (with assistance of Luc Van Oostenryck)
man-pages finally gets pages for these system calls, several
of which are obsolete in Linux 2.6.
Took the old GPLed pages dated 1996 and made a number of
clean-ups and minor additions.
Changes to individual pages
---------------------------

2
Changes.old
View File

@ -2895,7 +2895,7 @@ set_mempolicy.2
New pages describing the NUMA memory allocation policy API.
rtc.4
Urs Thuermann, with additoonal work by mtk
Urs Thuermann, with additional work by mtk
New page describing the real-time clock driver.
inotify.7

26
HOWTOHELP
View File

@ -190,7 +190,7 @@ Ritchie, with a few concessions:
if (func(...) == -1)
{ perror("func"); exit(EXIT_FAILURE); }
For some some examples of what example programs should look like, see
For some examples of what example programs should look like, see
the wait.2 and pipe.2 manual pages.
@ -216,10 +216,10 @@ If you are thinking of writing one or more of these pages, then:
(man2/fcntl.2).
-- The page must be submitted under some sort of license that permits
the page to be freely redistributed and modified. Include that license
in the source code of the manual page. Possible licenses include the
GPL, the BSD license, or a range of other licenses, some of which can
be seen in existing manual pages.
the page to be freely redistributed and modified. Include that
license or a reference to it, in the source code of the manual page.
Possible licenses include the GPL, the BSD license, or a range of
other licenses, some of which can be seen in existing manual pages.
-- You may find it useful to check the information in your page
against the specifications in SUSv3/POSIX.1-2001
@ -245,14 +245,13 @@ System Calls
add_key(2)
keyctl(2)
request_key(2)
delete_module(2)
init_module(2)
create_module(2) (Present up to and including kernel 2.4, absent in 2.6)
query_module(2) (Present up to and including kernel 2.4, absent in 2.6)
See:
Documentation/keys.txt
Documentation/keys-request-key.txt
ioprio_get(2) (new in kernel 2.6.13)
ioprio_set(2) (new in kernel 2.6.13)
See Documentation/block/ioprio.txt
mq_getsetattr(2)
mq_notify(2)
@ -261,9 +260,6 @@ mq_receive() / mq_timedreceive(2)
mq_send() / mq_timedsend(2)
mq_unlink(2)
Manual pages might also be useful for the following system calls:
get_kernel_syms(2) (Present up to and including kernel 2.4, absent in 2.6)
restart_syscall(2) (new in 2.6)
set_zone_reclaim(2) (new in kernel 2.6.13)
sys_kexec_load(2) (new in kernel 2.6.13)
@ -311,7 +307,7 @@ the complete API, describing details where LinuxThreads and NPTL diverge
from the standard. The existing pthreads(7) manual page, which gives an
overview of Pthreads implementations on Linux, is designed as a base
document for these manual pages. The list of required manual pages is
long, those marked with more asterisks are probably the most desirable
long; those marked with more asterisks are probably the most desirable
to get done first:
pthread_atfork() *

7
man2/fcntl.2
View File

@ -150,8 +150,8 @@ On Linux this command can only change the
and
.BR O_NONBLOCK
flags.
.\" FIXME According to SUSv3, O_SYNC should also be modifiable via
.\" fcntl(2), but currently Linux does not permit this
.\" FIXME According to SUSv3, O_SYNC should also be modifiable
.\" via fcntl(2), but currently Linux does not permit this
.\" See http://bugzilla.kernel.org/show_bug.cgi?id=5994
.P
.SS "Advisory locking"
@ -375,7 +375,8 @@ If you set the
status flag on a file descriptor (either by providing this flag with the
.BR open (2)
.\" FIXME The statement that O_ASYNC can be used in open() does not
.\" match reality; setting O_ASYNC via open() does not seem to be effective.
.\" match reality; setting O_ASYNC via open() does not seem to be
.\" effective.
.\" See http://bugzilla.kernel.org/show_bug.cgi?id=5993
call, or by using the
.B F_SETFL

4
man2/inotify_add_watch.2
View File

@ -105,8 +105,8 @@ In kernels before 2.6.16, the
.B IN_ONESHOT
.I mask
flag does not work.
.\" FIXME To be confirmed that the IN_ONESHOT fix made by Robert Love did
.\" actually make it into 2.6.16. (8 Feb 06)
.\" FIXME To be confirmed that the IN_ONESHOT fix made by Robert Love
.\" did actually make it into 2.6.16. (8 Feb 06)
.SH "SEE ALSO"
.BR inotify_init (2),
.BR inotify_rm_watch (2),

11
man3/getspnam.3
View File

@ -73,11 +73,12 @@ the traditional password database
.BR getpwnam (3)
and
.BR getpwent (3)).
.\" Jul 2005, mtk: FIXME I've commented out the following for the moment.
.\" The relationship between PAM and nsswitch.conf needs to be clearly
.\" documented in one place, which is pointed to by the pages for the
.\" user, group, and shadow password funtions.
.\" This shadow password setup has been superseded by PAM
.\" Jul 2005, mtk: FIXME I've commented out the following for the
.\" moment. The relationship between PAM and nsswitch.conf needs
.\" to be clearly documented in one place, which is pointed to by
.\" the pages for the user, group, and shadow password functions.
.\"
.\" This shadow password setup has been superseded by PAM
.\" (pluggable authentication modules), and the file
.\" .I /etc/nsswitch.conf
.\" now describes the sources to be used.

19
man3/sigset.3
View File

@ -121,11 +121,11 @@ On error,
returns \-1, with
.I errno
set to indicate the error.
.\" FIXME But as at 2.3.5, glibc's sigset() is broken for the SIG_HOLD
.\" case: it will only return SIG_HOLD if 'disp' is SIG_HOLD; if the
.\" signal is blocked, then sigset() should return SIG_HOLD even if
.\" 'disp' is specified as something other than SIG_HOLD (I have tested
.\" this on Solaris 8 and HP-UX 11).
.\" FIXME But as at 2.3.5, glibc's sigset() is broken for the
.\" SIG_HOLD case: it will only return SIG_HOLD if 'disp' is
.\" SIG_HOLD; if the signal is blocked, then sigset() should return
.\" SIG_HOLD even if 'disp' is specified as something other than
.\" SIG_HOLD (I have tested this on Solaris 8 and HP-UX 11).
.\" -- mtk, 29 Nov 05
.\" See http://sourceware.org/bugzilla/show_bug.cgi?id=1951
@ -234,10 +234,11 @@ Instead, the previous disposition of the signal is returned.
.\" See http://sourceware.org/bugzilla/show_bug.cgi?id=1951
.\"
.\" The SUSv3 disposition of sigset() says:
.\" Upon successful completion, sigset() shall return SIG_HOLD if the
.\" signal had been blocked and the signal's previous disposition if
.\" it had not been blocked. Otherwise, SIG_ERR shall be returned and
.\" errno set to indicate the error.
.\" Upon successful completion, sigset() shall return
.\" SIG_HOLD if the signal had been blocked and the signal's
.\" previous disposition if it had not been blocked.
.\" Otherwise, SIG_ERR shall be returned and errno set to
.\" indicate the error.
.SH "CONFORMING TO"
SVr4.
These functions are obsolete: do not use them in new programs.

2
man5/charmap.5
View File

@ -110,10 +110,8 @@ with a hexadecimal number
.TP
.I <escape_char><number>
with an octal number.
.\" FIXME - comments
.\" FIXME - char ... char
.SH FILES
.I /usr/share/i18n/charmaps/*
.SH AUTHOR

4
man5/ipc.5
View File

@ -20,8 +20,8 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" FIXME -- there is now duplication of some of the information below
.\" in semctl.2, msgctl.2, and shmctl.2 -- MTK, Nov 04
.\" FIXME -- there is now duplication of some of the information
.\" below in semctl.2, msgctl.2, and shmctl.2 -- MTK, Nov 04
.TH IPC 5 1993-11-01 "Linux 0.99.13" "Linux Programmer's Manual"
.SH NAME
ipc \- System V interprocess communication mechanisms

34
man5/proc.5
View File

@ -40,19 +40,21 @@
.\" 2005-09-16, mtk, Added /proc/sys/fs/suid_dumpable
.\" 2005-09-19, mtk, added /proc/zoneinfo
.\"
.\" 19 Sep 05: FIXME 2.6.14 has added /proc/PID/smaps (if CONFIG_MMU
.\" is enabled) and /proc/PID/numa_maps (if CONFIG_NUMA is enabled);
.\" they need to be documented.
.\" Info on smaps can be found in the patch-2.6.14-rc1 Changelog
.\" and in Documentation/filesystems/proc.txt
.\" Info on numa_maps can be found in the patch-2.6.14-rc1 Changelog
.\" 19 Sep 05: FIXME 2.6.13 seems to have /proc/vmcore implemented
.\" in the source code, but there is no option available under
.\" 'make xconfig'; eventually this should be fixed, and then info
.\" from the patch-2.6.13 and change log could be used to write an
.\" entry in this man page.
.\" FIXME -- cross check against Documentation/filesystems/proc.txt to see
.\" what information could be imported from that file into this file.
.\" FIXME 2.6.14 has added /proc/PID/smaps (if CONFIG_MMU
.\" is enabled) and /proc/PID/numa_maps (if CONFIG_NUMA is
.\" enabled); they need to be documented.
.\" Info on smaps can be found in the patch-2.6.14-rc1 Changelog
.\" and in Documentation/filesystems/proc.txt
.\" Info on numa_maps can be found in the patch-2.6.14-rc1
.\" Changelog
.\" FIXME 2.6.13 seems to have /proc/vmcore implemented
.\" in the source code, but there is no option available under
.\" 'make xconfig'; eventually this should be fixed, and then info
.\" from the patch-2.6.13 and change log could be used to write an
.\" entry in this man page.
.\" FIXME -- cross check against Documentation/filesystems/proc.txt
.\" to see what information could be imported from that file
.\" into this file.
.\"
.TH PROC 5 2005-05-12 "" "Linux Programmer's Manual"
.SH NAME
@ -931,7 +933,7 @@ that the system spent in user mode,
user mode with low priority (nice), system mode, and the
idle task, respectively.
.\" FIXME: Actually, the following does not seem to be quite
.\" right (at least in 2.6.12):
.\" right (at least in 2.6.12)
The last value should be USER_HZ times the
second entry in the uptime pseudo-file.
.sp
@ -942,8 +944,8 @@ In Linux 2.6 this line includes three additional columns:
\- time servicing interrupts (since 2.6.0-test4);
.I softirq
\- time servicing softirqs (since 2.6.0-test4).
.\" FIXME 2.6.11 adds a further column "steal" (see fs/proc/proc_misc.c)
.\" this is not yet described...
.\" FIXME 2.6.11 adds a further column "steal" (see
.\" fs/proc/proc_misc.c); this is not yet described...
.TP
\fIpage 5741 1808\fP
The number of pages the system paged in and the number that were paged

5
man7/ddp.7
View File

@ -149,8 +149,9 @@ Appletalk is supported by Linux 2.0 or higher. The
interface is
new in Linux 2.2.
.SH ERRORS
.\" FIXME document all errors. We should really fix the kernels to give
.\" give more uniform error returns (ENOMEM vs ENOBUFS, EPERM vs EACCES etc.)
.\" FIXME document all errors. We should really fix the kernels to
.\" give more uniform error returns (ENOMEM vs ENOBUFS, EPERM vs
.\" EACCES etc.)
.TP
.B ENOTCONN
The operation is only defined on a connected socket, but the socket wasn't

16
man7/ip.7
View File

@ -473,11 +473,13 @@ causing the error is returned as normal payload.
.\" sockets,
.\" .I IP_RECVERR
.\" has slightly different semantics. Instead of
.\" saving the errors for the next timeout, it passes all incoming errors
.\" immediately to the
.\" user. This might be useful for very short-lived TCP connections which
.\" need fast error handling. Use this option with care: it makes TCP unreliable
.\" by not allowing it to recover properly from routing shifts and other normal
.\" saving the errors for the next timeout, it passes all incoming
.\" errors immediately to the user.
.\" This might be useful for very short-lived TCP connections which
.\" need fast error handling. Use this option with care:
.\" it makes TCP unreliable
.\" by not allowing it to recover properly from routing
.\" shifts and other normal
.\" conditions and breaks the protocol specification.
Note that TCP has no error queue;
.B MSG_ERRQUEUE
@ -700,7 +702,7 @@ proxying are configured.
.\"
.TP
.B ip_autoconfig
.\" FIXME:
.\" FIXME: document ip_autoconfig
Not documented.
.\"
.TP
@ -791,7 +793,7 @@ package.
.PP
Ioctls to configure generic device parameters are described in
.BR netdevice (7).
.\" FIXME Add a chapter about multicasting
.\" FIXME Add a discussion of multicasting
.SH NOTES
Be very careful with the
.B SO_BROADCAST

4
man7/pthreads.7
View File

@ -252,7 +252,7 @@ Threads do not share a common nice value.
.IP \- 3
Only the main thread is permitted to start a new session using
.BR setsid (2).
.\" FIXME why is only the main thread is permitted to
.\" FIXME why is only the main thread permitted to
.\" start a new session using setsid()?
.\" Perhaps fixed in 2.6.16?
.\"
@ -260,7 +260,7 @@ Only the main thread is permitted to start a new session using
Only the main thread is permitted to make the process into a
process group leader using
.BR setpgid (2).
.\" FIXME why is only the main thread is permitted to make the
.\" FIXME why is only the main thread permitted to make the
.\" process into a process group leader using setpgid()?
.\" Perhaps fixed in 2.6.16?
.PP

1
man7/rtnetlink.7
View File

@ -36,7 +36,6 @@ sockets. It is based on netlink messages, see
for more information.
.\" FIXME: all these macros could be moved to rtnetlink(3)
.SH "ROUTING ATTRIBUTES"
Some rtnetlink messages have optional attributes after the initial header:

5
man7/socket.7
View File

@ -167,13 +167,12 @@ Urgent data arrived.
.B SIGURG
is sent then.
T}
.\" FIXME not true currently
.\" FIXME The following is not true currently:
.\" It is no I/O event when the connection
.\" is broken from the local end using
.\" .BR shutdown (2)
.\" or
.\" .BR close (2)
.\" .
.\" .BR close (2).
.TE
.PP