From 5258c28f5bacd6953d10dde5b365ef5b3beeb4b2 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sun, 27 Jan 2013 21:33:31 +0100 Subject: [PATCH] Start of man-pages-3.47: updating Changes and Changes.old --- Changes | 307 +---------------------------------------------- Changes.old | 340 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 342 insertions(+), 305 deletions(-) diff --git a/Changes b/Changes index fa6323468..86734679e 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,6 @@ -==================== Changes in man-pages-3.46 ==================== +==================== Changes in man-pages-3.47 ==================== -Released: 2013-01-27, Canberra +Released: ????-??-??, Munich Contributors @@ -10,32 +10,6 @@ The following people contributed patches/fixes or (noted in brackets in the changelog below) reports, notes, and ideas that have been incorporated in changes in this release: -Andrew Perepechko -Cédric Boutillier -Cyrill Gorcunov -Daan Spitz -David Prévot -Elie De Brauwer -Garrett Cooper -James Noble -Justin Lebar -Kees Cook -Lucas De Marchi -Mark Hills -Maxin B. John -Michael Kerrisk -Michal Gorny -Peter Budny -Peter Lekeynstein -Rusty Russell -Samuel Thibault -Sam Varshavchik -Shawn Landden -Simon Paillard -Starlight -Theodore Ts'o -Wolfgang Rohdewald -Zsbán Ambrus Apologies if I missed anyone! @@ -43,296 +17,19 @@ Apologies if I missed anyone! New and rewritten pages ----------------------- -kcmp.2 - Cyrill Gorcunov, Michael Kerrisk - New page for kcmp(2) - Newly documented interfaces in existing pages --------------------------------------------- -init_module.2 - Michael Kerrisk [Kees Cook, Rusty Russell, Lucas De Marchi] - Document finit_module(2) - Rusty Russell [Lucas De Marchi, Kees Cook] - Document finit_module() 'flags' argument - Document MODULE_INIT_IGNORE_MODVERSIONS and - MODULE_INIT_IGNORE_VERMAGIC. (Some edits by mtk.) - New and changed links --------------------- -finit_module.2 - Michael Kerrisk - New link to init_module.2 - -__after_morecore_hook.3 -__free_hook.3 -__malloc_initialize_hook.3 -__memalign_hook.3 -__realloc_hook.3 - Michael Kerrisk - New link to malloc_hook.3 - Global changes -------------- -Various pages - Michael Kerrisk - Global fix: s/tty/terminal/ - Changes to individual pages --------------------------- -clone.2 - Michael Kerrisk - Add kernel versions for various CLONE_* constants - Michael Kerrisk - CLONE_NEWIPC governs mechanisms that don't have filesystem pathnames - Michael Kerrisk - CLONE_NEWIPC doesn't mount the POSIX MQ file system - Michael Kerrisk - Add an example program (CLONE_NEWUTS) - Michael Kerrisk - Some reworking of CLONE_NEWIPC text - No substantial content changes. - Michael Kerrisk - SEE ALSO: add kcmp(2) - SEE ALSO: add setns(2) - -fallocate.2 - Michael Kerrisk - FALLOC_FL_* flags are defined in glibc only since 2.18 - -getxattr.2 -removexattr.2 -setxattr.2 - Michael Kerrisk [Andrew Perepechko, ] - Note that ENOATTR is a synonym for ENODATA - Various people have pointed out that strace(1) shows ENODATA - for the case where the named attribute does not exist, or - the process has no access to this attribute. ENODATA - and ENOATTR are in fact defined as synonyms. Point this out - in the man page, so that people understand the strace(1) info. - - See https://bugzilla.kernel.org/show_bug.cgi?id=51871 - -getxattr.2 -listxattr.2 -removexattr.2 -setxattr.2 - Michael Kerrisk - Put errors under ERRORS section - The errno values on these pages were listed in a nonstandard - way under the RETURN VALUE section. Put them in ERRORS sections. - -init_module.2 - Michael Kerrisk [Rusty Russell] - ERRORS: Add errors for module signatures (EBADMSG, ENOKEY) - -link.2 -mkdir.2 -mknod.2 -open.2 -rename.2 -symlink.2 -write.2 -mkfifo.3 - Mark Hills - Document EDQUOT error - The return error EDQUOT is not documented in open(2), write(2), - symlink(2) etc. - - Whether inodes or disk blocks are required for each function - is something I based on received wisdom and BSD documentation, - rather than tracing the code to the kernel. For symlink(2) - this certainly depends on the file system type. - -listxattr.2 - Michael Kerrisk [Theodore Ts'o] - Fix RETURN VALUE description - On success, 0 may be returned, so change wording from - "positive number" to "nonnegative number". - -outb.2 - Michael Kerrisk - Add SYNOPSIS - -prctl.2 - Kees Cook - Document PR_SET_PTRACER - Document the Yama LSM's prctl handler that allows processes to - declare ptrace restriction exception relationships via - PR_SET_PTRACER. - Michael Kerrisk - Make it explicit that PR_SET_PTRACER replaces previous setting - The attribute is a scalar, not a list. - Shawn Landden - Document EINVAL error for PR_SET_PTRACER - Michael Kerrisk - Document PR_GET_TID_ADDRESS - -ptrace.2 - Michael Kerrisk - Document PTRACE_O_EXITKILL - Michael Kerrisk - Place PTRACE_SETOPTIONS list in alphabetical order - -query_module.2 - Michael Kerrisk - Must be called using syscall(2) - Yes, the call is way obsolete, but add this info - for completeness. - -recvmmsg.2 - Elie De Brauwer - Add/correct kernel version info for recvmmsg() and MSG_WAITFORNONE - This patch isolates the since/version related fixes as requested. - This change introduces the following delta: - * The page states it was added in 2.6.32 but it is only added - 2.6.33 (ref: http://kernelnewbies.org/Linux_2_6_33) - * The MSG_WAITFORONE flag was in turn only added in 2.6.34 - (ref: http://kernelnewbies.org/Linux_2_6_34) - Elie De Brauwer - Add an example program - -setns.2 - Michael Kerrisk - Add example program - -sigaction.2 - Michael Kerrisk [Zsbán Ambrus] - Note feature test macro requirements for 'siginfo_t' - See https://bugzilla.kernel.org/show_bug.cgi?id=52931 - -syscalls.2 - Michael Kerrisk - Add kern_features(2) - Michael Kerrisk - Add utrap_install(2) - Sparc-specific, present since ancient times - Michael Kerrisk - Add finit_module(2) - -sysctl.2 - Michael Kerrisk [Garrett Cooper] - ERRORS: EACCES as a synonym for EPRM - See https://bugzilla.kernel.org/show_bug.cgi?id=46731 - and http://thread.gmane.org/gmane.linux.ltp/11413/focus=957635 - From: Garrett Cooper gmail.com> - Subject: Re: [LTP] [PATCH] sysctl03: sysctl returns EACCES after 2.6.33-rc1 - Newsgroups: gmane.linux.kernel, gmane.linux.ltp - Date: 2010-03-04 18:35:33 GMT - -unshare.2 - Michael Kerrisk - Update NOTES on unimplemented flags - Michael Kerrisk - Fix text problems in description of CLONE_FS - Michael Kerrisk - SEE ALSO: add kcmp(2) - SEE ALSO: add setns(2) - Michael Kerrisk - Reorder CLONE_NEWUTS entry in list - -difftime.3 - Michael Kerrisk [Michal Gorny] - Remove crufty text about 'time_t' on "other systems" - Back in 2006, some text came in via Debian patches that seems - crufty. Remove it. - - See https://bugzilla.kernel.org/show_bug.cgi?id=46731 - -getaddrinfo.3 -getnameinfo.3 - Michael Kerrisk [Peter Budny] - Fix some confused references to function names - See https://bugzilla.kernel.org/show_bug.cgi?id=52741 - -getspnam.3 - Michael Kerrisk [Wolfgang Rohdewald] - ERRORS: Add EACCES - See https://bugzilla.kernel.org/show_bug.cgi?id=52681 - -__setfpucw.3 - Michael Kerrisk - Add proper page cross refs for alternate functions - -core.5 -proc.5 - Kees Cook - Clarify suid_dumpable versus core_pattern - In Linux 3.6, additional requirements were placed on core_pattern - when suid_dumpable is set to 2. Document this and include commit - references. - -proc.5 - Justin Lebar - statm's "shared" field refers to pages backed by files - I noticed that statm's "shared" field doesn't match the sum of - all the "shared" entries in smaps [1]. - - The kernel docs explain that statm's "shared" field is "number of - pages that are shared (i.e. backed by a file)" [2]. smaps appears - to call a page shared if it's mapped by at least two processes, - which explains this discrepancy. - - I'm not a kernel hacker, but it appears to me they do mean "i.e." - and not "e.g." in the statm description: In - fs/proc/task_mmu.c::task_statm, I see - - *shared = get_mm_counter(mm, MM_FILEPAGES); - - Here's a patch which updates the man page to match the (hopefully - correct) kernel docs. - - [1] https://bugzilla.mozilla.org/show_bug.cgi?id=807181 - [2] http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob;f=Documentation/filesystems/proc.txt;h=a1793d670cd01bd374eddf54ffdfc768504291ff;hb=HEAD - -proc.5 - Kees Cook - Put /proc/sys/kernel/hotplug in alphabetical order - Kees Cook - Document /proc/sys/kernel/dmesg_restrict - Kees Cook - Linux 3.4 changed permissions needed to change kptr_restrict - Michael Kerrisk [Samuel Thibault, Simon Paillard] - Add field numbers for /proc/PID/stat - See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=553413 - Add numbering to /proc/stat "cpu" fields - See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=553413 - Michael Kerrisk - Reorganize text describing /proc/stat "cpu" fields - Michael Kerrisk - Rewording of suid_dumpable text after comments from Kees Cook - Michael Kerrisk [Samuel Thibault, Simon Paillard] - Add field numbers for /proc/[pid]/statm - See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=553413 - Michael Kerrisk - Document /proc/stat "cpu" "nice_guest" field - Info taken from commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797 - Michael Kerrisk [Peter Lekeynstein] - Document /prod/[pid]/oom_score_adj - Text taken directly from Documentation/filesystems/proc.txt, - with some light editing. - - See https://bugzilla.kernel.org/show_bug.cgi?id=50421 - -shells.5 - Michael Kerrisk - Add /etc/bash to list of example shells - -ttytype.5 - Michael Kerrisk - Add proper xref for termcap and terminfo pages - -capabilities.7 - Michael Kerrisk - Add kcmp(2) under CAP_SYS_PTRACE - -man-pages.7 - Michael Kerrisk - Update description of Section 7 diff --git a/Changes.old b/Changes.old index f51b3e6bf..b9341ebab 100644 --- a/Changes.old +++ b/Changes.old @@ -25188,3 +25188,343 @@ socket.7 Explain effect of SO_SNDTIMEO for connect() When SO_SNDTIMEO is set before connect(), then connect() may return EWOULDBLOCK when the timeout fires. + + +==================== Changes in man-pages-3.46 ==================== + +Released: 2013-01-27, Canberra + + +Contributors +------------ + +The following people contributed patches/fixes or (noted in brackets +in the changelog below) reports, notes, and ideas that have been +incorporated in changes in this release: + +Andrew Perepechko +Cédric Boutillier +Cyrill Gorcunov +Daan Spitz +David Prévot +Elie De Brauwer +Garrett Cooper +James Noble +Justin Lebar +Kees Cook +Lucas De Marchi +Mark Hills +Maxin B. John +Michael Kerrisk +Michal Gorny +Peter Budny +Peter Lekeynstein +Rusty Russell +Samuel Thibault +Sam Varshavchik +Shawn Landden +Simon Paillard +Starlight +Theodore Ts'o +Wolfgang Rohdewald +Zsbán Ambrus + +Apologies if I missed anyone! + + +New and rewritten pages +----------------------- + +kcmp.2 + Cyrill Gorcunov, Michael Kerrisk + New page for kcmp(2) + + +Newly documented interfaces in existing pages +--------------------------------------------- + +init_module.2 + Michael Kerrisk [Kees Cook, Rusty Russell, Lucas De Marchi] + Document finit_module(2) + Rusty Russell [Lucas De Marchi, Kees Cook] + Document finit_module() 'flags' argument + Document MODULE_INIT_IGNORE_MODVERSIONS and + MODULE_INIT_IGNORE_VERMAGIC. (Some edits by mtk.) + + +New and changed links +--------------------- + +finit_module.2 + Michael Kerrisk + New link to init_module.2 + +__after_morecore_hook.3 +__free_hook.3 +__malloc_initialize_hook.3 +__memalign_hook.3 +__realloc_hook.3 + Michael Kerrisk + New link to malloc_hook.3 + + +Global changes +-------------- + +Various pages + Michael Kerrisk + Global fix: s/tty/terminal/ + + +Changes to individual pages +--------------------------- + +clone.2 + Michael Kerrisk + Add kernel versions for various CLONE_* constants + Michael Kerrisk + CLONE_NEWIPC governs mechanisms that don't have filesystem pathnames + Michael Kerrisk + CLONE_NEWIPC doesn't mount the POSIX MQ file system + Michael Kerrisk + Add an example program (CLONE_NEWUTS) + Michael Kerrisk + Some reworking of CLONE_NEWIPC text + No substantial content changes. + Michael Kerrisk + SEE ALSO: add kcmp(2) + SEE ALSO: add setns(2) + +fallocate.2 + Michael Kerrisk + FALLOC_FL_* flags are defined in glibc only since 2.18 + +getxattr.2 +removexattr.2 +setxattr.2 + Michael Kerrisk [Andrew Perepechko, ] + Note that ENOATTR is a synonym for ENODATA + Various people have pointed out that strace(1) shows ENODATA + for the case where the named attribute does not exist, or + the process has no access to this attribute. ENODATA + and ENOATTR are in fact defined as synonyms. Point this out + in the man page, so that people understand the strace(1) info. + + See https://bugzilla.kernel.org/show_bug.cgi?id=51871 + +getxattr.2 +listxattr.2 +removexattr.2 +setxattr.2 + Michael Kerrisk + Put errors under ERRORS section + The errno values on these pages were listed in a nonstandard + way under the RETURN VALUE section. Put them in ERRORS sections. + +init_module.2 + Michael Kerrisk [Rusty Russell] + ERRORS: Add errors for module signatures (EBADMSG, ENOKEY) + +link.2 +mkdir.2 +mknod.2 +open.2 +rename.2 +symlink.2 +write.2 +mkfifo.3 + Mark Hills + Document EDQUOT error + The return error EDQUOT is not documented in open(2), write(2), + symlink(2) etc. + + Whether inodes or disk blocks are required for each function + is something I based on received wisdom and BSD documentation, + rather than tracing the code to the kernel. For symlink(2) + this certainly depends on the file system type. + +listxattr.2 + Michael Kerrisk [Theodore Ts'o] + Fix RETURN VALUE description + On success, 0 may be returned, so change wording from + "positive number" to "nonnegative number". + +outb.2 + Michael Kerrisk + Add SYNOPSIS + +prctl.2 + Kees Cook + Document PR_SET_PTRACER + Document the Yama LSM's prctl handler that allows processes to + declare ptrace restriction exception relationships via + PR_SET_PTRACER. + Michael Kerrisk + Make it explicit that PR_SET_PTRACER replaces previous setting + The attribute is a scalar, not a list. + Shawn Landden + Document EINVAL error for PR_SET_PTRACER + Michael Kerrisk + Document PR_GET_TID_ADDRESS + +ptrace.2 + Michael Kerrisk + Document PTRACE_O_EXITKILL + Michael Kerrisk + Place PTRACE_SETOPTIONS list in alphabetical order + +query_module.2 + Michael Kerrisk + Must be called using syscall(2) + Yes, the call is way obsolete, but add this info + for completeness. + +recvmmsg.2 + Elie De Brauwer + Add/correct kernel version info for recvmmsg() and MSG_WAITFORNONE + This patch isolates the since/version related fixes as requested. + This change introduces the following delta: + * The page states it was added in 2.6.32 but it is only added + 2.6.33 (ref: http://kernelnewbies.org/Linux_2_6_33) + * The MSG_WAITFORONE flag was in turn only added in 2.6.34 + (ref: http://kernelnewbies.org/Linux_2_6_34) + Elie De Brauwer + Add an example program + +setns.2 + Michael Kerrisk + Add example program + +sigaction.2 + Michael Kerrisk [Zsbán Ambrus] + Note feature test macro requirements for 'siginfo_t' + See https://bugzilla.kernel.org/show_bug.cgi?id=52931 + +syscalls.2 + Michael Kerrisk + Add kern_features(2) + Michael Kerrisk + Add utrap_install(2) + Sparc-specific, present since ancient times + Michael Kerrisk + Add finit_module(2) + +sysctl.2 + Michael Kerrisk [Garrett Cooper] + ERRORS: EACCES as a synonym for EPRM + See https://bugzilla.kernel.org/show_bug.cgi?id=46731 + and http://thread.gmane.org/gmane.linux.ltp/11413/focus=957635 + From: Garrett Cooper gmail.com> + Subject: Re: [LTP] [PATCH] sysctl03: sysctl returns EACCES after 2.6.33-rc1 + Newsgroups: gmane.linux.kernel, gmane.linux.ltp + Date: 2010-03-04 18:35:33 GMT + +unshare.2 + Michael Kerrisk + Update NOTES on unimplemented flags + Michael Kerrisk + Fix text problems in description of CLONE_FS + Michael Kerrisk + SEE ALSO: add kcmp(2) + SEE ALSO: add setns(2) + Michael Kerrisk + Reorder CLONE_NEWUTS entry in list + +difftime.3 + Michael Kerrisk [Michal Gorny] + Remove crufty text about 'time_t' on "other systems" + Back in 2006, some text came in via Debian patches that seems + crufty. Remove it. + + See https://bugzilla.kernel.org/show_bug.cgi?id=46731 + +getaddrinfo.3 +getnameinfo.3 + Michael Kerrisk [Peter Budny] + Fix some confused references to function names + See https://bugzilla.kernel.org/show_bug.cgi?id=52741 + +getspnam.3 + Michael Kerrisk [Wolfgang Rohdewald] + ERRORS: Add EACCES + See https://bugzilla.kernel.org/show_bug.cgi?id=52681 + +__setfpucw.3 + Michael Kerrisk + Add proper page cross refs for alternate functions + +core.5 +proc.5 + Kees Cook + Clarify suid_dumpable versus core_pattern + In Linux 3.6, additional requirements were placed on core_pattern + when suid_dumpable is set to 2. Document this and include commit + references. + +proc.5 + Justin Lebar + statm's "shared" field refers to pages backed by files + I noticed that statm's "shared" field doesn't match the sum of + all the "shared" entries in smaps [1]. + + The kernel docs explain that statm's "shared" field is "number of + pages that are shared (i.e. backed by a file)" [2]. smaps appears + to call a page shared if it's mapped by at least two processes, + which explains this discrepancy. + + I'm not a kernel hacker, but it appears to me they do mean "i.e." + and not "e.g." in the statm description: In + fs/proc/task_mmu.c::task_statm, I see + + *shared = get_mm_counter(mm, MM_FILEPAGES); + + Here's a patch which updates the man page to match the (hopefully + correct) kernel docs. + + [1] https://bugzilla.mozilla.org/show_bug.cgi?id=807181 + [2] http://git.kernel.org/?p=linux/kernel/git/torvalds/linux.git;a=blob;f=Documentation/filesystems/proc.txt;h=a1793d670cd01bd374eddf54ffdfc768504291ff;hb=HEAD + +proc.5 + Kees Cook + Put /proc/sys/kernel/hotplug in alphabetical order + Kees Cook + Document /proc/sys/kernel/dmesg_restrict + Kees Cook + Linux 3.4 changed permissions needed to change kptr_restrict + Michael Kerrisk [Samuel Thibault, Simon Paillard] + Add field numbers for /proc/PID/stat + See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=553413 + Add numbering to /proc/stat "cpu" fields + See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=553413 + Michael Kerrisk + Reorganize text describing /proc/stat "cpu" fields + Michael Kerrisk + Rewording of suid_dumpable text after comments from Kees Cook + Michael Kerrisk [Samuel Thibault, Simon Paillard] + Add field numbers for /proc/[pid]/statm + See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=553413 + Michael Kerrisk + Document /proc/stat "cpu" "nice_guest" field + Info taken from commit ce0e7b28fb75cb003cfc8d0238613aaf1c55e797 + Michael Kerrisk [Peter Lekeynstein] + Document /prod/[pid]/oom_score_adj + Text taken directly from Documentation/filesystems/proc.txt, + with some light editing. + + See https://bugzilla.kernel.org/show_bug.cgi?id=50421 + +shells.5 + Michael Kerrisk + Add /etc/bash to list of example shells + +ttytype.5 + Michael Kerrisk + Add proper xref for termcap and terminfo pages + +capabilities.7 + Michael Kerrisk + Add kcmp(2) under CAP_SYS_PTRACE + +man-pages.7 + Michael Kerrisk + Update description of Section 7