mirror of https://github.com/mkerrisk/man-pages
Ready for 2.49
This commit is contained in:
Michael Kerrisk
parent
cd8a9ce442
commit
c710d55271
123
Changes
123
Changes
|
|
@ -5,11 +5,11 @@ Released: 2007-??-??
|
|||
Contributors
|
||||
------------
|
||||
|
||||
Bruni Haible <bruno@clisp.org>
|
||||
|
||||
The following people contributed notes, ideas, or patches that have
|
||||
been incorporated in changes in this release:
|
||||
|
||||
Bruno Haible <bruno@clisp.org>
|
||||
Justin Pryzby <justinpryzby@users.sourceforge.net>
|
||||
|
||||
Apologies if I missed anyone!
|
||||
|
||||
|
|
@ -17,6 +17,43 @@ Apologies if I missed anyone!
|
|||
New pages
|
||||
---------
|
||||
|
||||
bsd_signal.3
|
||||
mtk
|
||||
Documentation of bsd_signal().
|
||||
|
||||
euidaccess.3
|
||||
mtk
|
||||
Manual page for euidaccess() and eaccess().
|
||||
|
||||
getsubopt.3
|
||||
mtk / Justin Pryzby
|
||||
Documentation of getsubopt().
|
||||
|
||||
sysv_signal.3
|
||||
mtk
|
||||
Documentation of sysv_signal().
|
||||
|
||||
|
||||
New links
|
||||
---------
|
||||
|
||||
epoll_pwait.2
|
||||
mtk
|
||||
New link to epoll_wait.2.
|
||||
|
||||
eaccess.3
|
||||
mtk
|
||||
New link to new euidaccess.3,
|
||||
|
||||
sem_timedwait.3
|
||||
mtk
|
||||
New link to sem_wait.3.
|
||||
|
||||
sem_trywait.3
|
||||
mtk
|
||||
New link to sem_wait.3.
|
||||
|
||||
|
||||
Global changes
|
||||
--------------
|
||||
|
||||
|
|
@ -27,6 +64,70 @@ places.
|
|||
Changes to individual pages
|
||||
---------------------------
|
||||
|
||||
access.3
|
||||
mtk
|
||||
Added SEE ALSO ref to new euidaccess.3 page.
|
||||
|
||||
epoll_pwait.2
|
||||
mtk
|
||||
Added description of epoll_pwait(), new in kernel 2.6.19.
|
||||
|
||||
execve.2
|
||||
mtk
|
||||
Add text noting that Linux allows 'argv' and 'envp' to be
|
||||
NULL, but warning that this is non-standard and non-portable,
|
||||
and should be avoided in portable programs.
|
||||
Bug filed (http://bugzilla.kernel.org/show_bug.cgi?id=8408)
|
||||
to get this changed, but maybe that won't be done because it
|
||||
is an ABI change.
|
||||
mtk
|
||||
Added an example program.
|
||||
mtk
|
||||
Expanded the discussion of interpreter scripts and the
|
||||
'optional-arg' argument of an interpreter script.
|
||||
For further info, see
|
||||
http://homepages.cwi.nl/~aeb/std/hashexclam-1.html
|
||||
http://www.in-ulm.de/~mascheck/various/shebang/
|
||||
mtk
|
||||
Added text noting that FD_CLOEXEC causes record locks to be
|
||||
released.
|
||||
mtk
|
||||
Mention effect of MS_NOSUID mount(2) flag for set-user-ID
|
||||
programs.
|
||||
mtk
|
||||
Expanded description of handling of file descriptors during
|
||||
execve(), adding text to note that descriptors 0, 1, and 2
|
||||
may be treated specially.
|
||||
|
||||
faccessat.3
|
||||
mtk
|
||||
Added SEE ALSO ref to new euidaccess.3 page.
|
||||
|
||||
mmap.2
|
||||
mtk
|
||||
Place MAP_* flags list in alphabetical order.
|
||||
|
||||
readv.2
|
||||
mtk
|
||||
A fairly substantial rewrite, which among other things
|
||||
fixes the problem reported by Kyle Sluder in
|
||||
http://bugzilla.kernel.org/show_bug.cgi?id=8399
|
||||
And added some example code.
|
||||
|
||||
sigaction.2
|
||||
mtk
|
||||
Added text referring to the discussion of async-signal-safe
|
||||
functions in signal(7).
|
||||
A few other minor formatting and wording changes.
|
||||
|
||||
signal.2
|
||||
mtk
|
||||
Moved the discussion of async-signal-safe functions to signal(7).
|
||||
Added text referring to the discussion of async-signal-safe
|
||||
functions in signal(7).
|
||||
Added SEE ALSO entries referring to new bsd_signal.3 and
|
||||
sysv_signal.3 pages.
|
||||
|
||||
copysign.3
|
||||
Bruno Haible
|
||||
Clarify discussion of negative zero.
|
||||
|
|
@ -34,8 +135,24 @@ copysign.3
|
|||
iconv_open.3
|
||||
Bruno Haible
|
||||
Describe the glibc/libiconv //TRANSLIT and //IGNORE extensions
|
||||
for 'tocode'.
|
||||
for 'tocode'.
|
||||
|
||||
iswblank.3
|
||||
Bruno Haible
|
||||
Update CONFORMING TO; iswblank() is in POSIX.1-2001.
|
||||
|
||||
subopt.3
|
||||
mtk
|
||||
Add SEE ALSO ref to new getsubopt.3.
|
||||
|
||||
inotify.7
|
||||
mtk
|
||||
Defintions for IN_DONT_FOLLOW, IN_MASK_ADD, and IN_ONLYDIR
|
||||
were added to glibc in version 2.5.
|
||||
|
||||
signal.7
|
||||
mtk
|
||||
Incorporated (and slightly modified) the text on
|
||||
async-signal-safe functions that was formerly in signal(2).
|
||||
Added SEE ALSO entries referring to new bsd_signal.3 and
|
||||
sysv_signal.3 pages.
|
||||
|
|
|
|||
|
|
@ -5951,7 +5951,7 @@ sched_rr_get_interval.2
|
|||
mtk
|
||||
Remove crufty statement that this system call is not implemented.
|
||||
The nice interval can be used to control the size of
|
||||
the round-robin quantum.
|
||||
the round-robin quantum.
|
||||
Corrected .TH line.
|
||||
|
||||
ip.7
|
||||
|
|
|
|||
43
HOWTOHELP
43
HOWTOHELP
|
|
@ -85,9 +85,9 @@ When you submit a patch, please note the following:
|
|||
|
||||
-- If editing a page, and you find one or two white spaces at the end
|
||||
of an existing line, DON'T bother removing them. The reason is
|
||||
that in a "diff -u" this will make it look like there is a change
|
||||
when in fact nothing has changed. In most cases, these extra white
|
||||
spaces do no harm, so just leave them be.
|
||||
that in a "diff -u" patch this will make it look like there is a
|
||||
change when in fact nothing has changed. In most cases, these
|
||||
extra white spaces do no harm, so just leave them be.
|
||||
|
||||
|
||||
MANUAL PAGES IN OTHER PACKAGES
|
||||
|
|
@ -103,9 +103,10 @@ If you want to submit a patch for a manual page that comes from another
|
|||
source, then you need to work out where the manual page comes from
|
||||
(i.e., which package) and who the maintainer of that manual page is.
|
||||
|
||||
On an RPM-based distribution, you can do the following to find out
|
||||
which package owns a particular file. For example, suppose we want
|
||||
to find out who maintains the fstab(5) manual page:
|
||||
On an RPM-based distribution (e..g., SUSE, Red Had, Mandriva), you
|
||||
can do the following to find out which package owns a particular file.
|
||||
For example, suppose we want to find out who maintains the fstab(5)
|
||||
manual page:
|
||||
|
||||
$ man -w fstab
|
||||
/usr/share/man/man5/fstab.5.gz
|
||||
|
|
@ -136,6 +137,10 @@ pages are modified by Debian. The maintainer of the original package
|
|||
can usually be found in a README in /usr/share/doc/<package-name>.
|
||||
Use "dpkg -L mount" to find all files from the mount package.
|
||||
|
||||
On Gentoo, we can use the "equery belongs" command to do similar:
|
||||
|
||||
$ equery belongs $(man -w fstab)
|
||||
|
||||
(FIXME: add instructions for doing the equivalent of the above on
|
||||
distributions that use other schemes.)
|
||||
|
||||
|
|
@ -155,7 +160,7 @@ REPAIRING PAGES MARKED "FIXME"
|
|||
==============================
|
||||
|
||||
Grepping the source of the manual pages will show various places where
|
||||
pages are marked with the string FIXME. There is also shell script
|
||||
pages are marked with the string FIXME. There is also a shell script
|
||||
(scripts/FIXME_list.sh) that can be used to obtain a list of FIXMEs
|
||||
in the manual page sources:
|
||||
|
||||
|
|
@ -164,7 +169,7 @@ in the manual page sources:
|
|||
|
||||
The presence of a FIXME usually indicates that someone has
|
||||
noticed that some information on the page is incorrect or
|
||||
incomplete, but has not had the time/knowledge to fix problem.
|
||||
incomplete, but has not had the time/knowledge to fix the problem.
|
||||
(Sometimes a FIXME relates to a kernel or glibc bug report that is
|
||||
awaiting resolution, and it may be sufficient to check if the bug
|
||||
has been resolved and then provide a suitable write-up on the page.)
|
||||
|
|
@ -184,8 +189,8 @@ Please keep source code line length <= 72 characters wherever possible.
|
|||
This helps avoid line-wrapping in some mail clients when patches are
|
||||
submitted inline.
|
||||
|
||||
New sentences are generally best started on new lines. This makes
|
||||
it easier to see the effect of patches, which often operate at the
|
||||
New sentences should be started on new lines. This makes it easier
|
||||
to see the effect of patches, which often operate at the
|
||||
level of individual sentences.
|
||||
|
||||
|
||||
|
|
@ -218,7 +223,7 @@ function. However, note the following:
|
|||
input read by the program).
|
||||
|
||||
Example programs should be laid out according to Kernighan and
|
||||
Ritchie, with a few concessions:
|
||||
Ritchie style, with a few concessions:
|
||||
|
||||
-- 4-space indents are preferred. (Avoid the use of TAB characters
|
||||
in source code!)
|
||||
|
|
@ -311,12 +316,15 @@ get_robust_list(2) Information can be found in the 2.6.17 ChangeLog
|
|||
|
||||
move_pages(2) New in 2.6.18
|
||||
|
||||
epoll_pwait(2) New in 2.6.19
|
||||
|
||||
lutimesat(2) Likely to appear in a future kernel
|
||||
|
||||
fallocate(2) May appear in a future kernel
|
||||
|
||||
signalfd(2) Likely to appear around 2.6.23 (or pollfs?)
|
||||
See http://lwn.net/Articles/225714/
|
||||
timerfd(2) Likely to appear around 2.6.22 (or pollfs?)
|
||||
See http://lwn.net/Articles/225714/
|
||||
|
||||
/sys file system
|
||||
----------------
|
||||
|
||||
|
|
@ -329,9 +337,10 @@ this page.
|
|||
Library Functions
|
||||
-----------------
|
||||
|
||||
(See a further list of missing pages in the "undocumented(3)" manual page.
|
||||
(See a further list of missing pages in the "undocumented(3)"
|
||||
manual page.)
|
||||
|
||||
Searches like the following are likely to sugest other functions
|
||||
Searches like the following are likely to suggest other functions
|
||||
that need to be documented:
|
||||
|
||||
|
||||
|
|
@ -347,7 +356,6 @@ for f in $(cat $(echo $GLIBCDIR/abilist/*.abilist) | grep -v 'GLIBC' | \
|
|||
done
|
||||
)
|
||||
|
||||
bsd_signal(3)
|
||||
clock_nanosleep(3)
|
||||
crypt_r(3) (To be added to crypt.3)
|
||||
dlinfo(3) (Solaris and FreeBSD have a similar function.)
|
||||
|
|
@ -355,11 +363,9 @@ dladdr1(3)
|
|||
dlmopen(3) (Solaris has a similar function; since glibc 2.3.4;
|
||||
probably to be documented in dlopen.3)
|
||||
etext, edata, end (variables)
|
||||
euidaccess(3) / eaccess(3)
|
||||
fdopendir(3) (since glibc 2.4)
|
||||
fopencookie(3)
|
||||
getgrouplist(3) (since glibc 2.2.4)
|
||||
getsubopt(3)
|
||||
getutmp(3)
|
||||
getutmpx(3)
|
||||
gnu_get_libc_release(3)
|
||||
|
|
@ -375,7 +381,6 @@ sigstack(3)
|
|||
sigwait(3)
|
||||
strftime_l(3) (since glibc 2.3)
|
||||
strptime_l(3) (since glibc 2.3.2)
|
||||
sysv_signal(3)
|
||||
tmpnam_r(3) (probably as additional text in tmpnam.3)
|
||||
updwtmpx(3)
|
||||
|
||||
|
|
|
|||
10
MAINTAINING
10
MAINTAINING
|
|
@ -37,7 +37,7 @@ Glibc source code
|
|||
|
||||
Same story as the kernel.
|
||||
|
||||
-- Keep up to date trees for 2.0.x, 2.1.x, 2.2.x, 2.3.x, 2.4.x.
|
||||
-- Keep up to date trees for all 2.x, x >= 0 releases.
|
||||
|
||||
-- Keep diff files for all minor releases of the glibc tree.
|
||||
As with kernel, these can be grepped to help determine
|
||||
|
|
@ -65,7 +65,7 @@ Linux Kernel (LKML)
|
|||
subscribe linux-kernel
|
||||
|
||||
The problem with this list is that the volume is extremely high,
|
||||
so keeping track of it all would require a lot of time.
|
||||
so keeping close track of it all would require a lot of time.
|
||||
|
||||
http://www.kernel.org/ provides the locations of a few searchable
|
||||
archives of this mailing list.
|
||||
|
|
@ -90,7 +90,7 @@ http://kerneltrap.org/news
|
|||
Kernel releases
|
||||
---------------
|
||||
|
||||
When a new minor kernel release is made (e.g., 2.6.19), scan the
|
||||
When a new minor kernel release is made (e.g., 2.6.22), scan the
|
||||
patch and Changelog, to see what important changes there have been.
|
||||
This is quite a big job, and pretty much impossible to do thoroughly,
|
||||
unless doing man-pages is your full time job, but a bit of scripting
|
||||
|
|
@ -113,7 +113,7 @@ found at http://bugs.debian.org/cgi-bin/pkgreport.cgi?src=manpages.
|
|||
|
||||
Debian even provides an email interface which allows an upstream
|
||||
maintainer to manipulate Debian bug reports (using the "tags"
|
||||
command; see http://www.debian.org/Bugs/server-control.
|
||||
command; see http://www.debian.org/Bugs/server-control).
|
||||
|
||||
Perhaps some other distributions do the same, but Debian is the
|
||||
only one I know about so far.
|
||||
|
|
@ -182,7 +182,7 @@ electronic form.
|
|||
And get the C99 standard. There are electronic versions of near
|
||||
final drafts available on the net, if one searches on the net.
|
||||
|
||||
And have a look at the LSB, http://www.freestandards.org/.
|
||||
And have a look at the LSB, http://www.linux-foundation.org/en/LSB.
|
||||
|
||||
Other Manual Pages
|
||||
------------------
|
||||
|
|
|
|||
4
TODO
4
TODO
|
|
@ -37,8 +37,8 @@ Markup language
|
|||
The existing man-pages set is an unfortunate mixture pages written in
|
||||
two formats: 'man' and 'mdoc' (BSD). Neither is optimal, since they
|
||||
don't encode sufficient semantic detail about the elements of a page.
|
||||
What is required is a new markup language (probably some form of
|
||||
docbook) that:
|
||||
What is perhaps required is a new markup language (probably some form
|
||||
of docbook) that:
|
||||
|
||||
a) is unintrusive: the raw page source should remain very readable
|
||||
b) applies markup by function, not by effect
|
||||
|
|
|
|||
Loading…
Reference in New Issue