path: root/Changes

==================== Changes in man-pages-3.04 ====================

Released: 2008-07-09, Konolfingen


Contributors
------------

The following people contributed notes, ideas, or patches that have
been incorporated in changes in this release:

Alain Portal <aportal@univ-montp2.fr>
Andrea Arcangeli <andrea@cpushare.com>
Andreas Mohr <andi@lisas.de>
Andrew Morgan <morgan@kernel.org>
Erik Bosman <ejbosman@cs.vu.nl>
John Brooks <aspecialj@gmail.com>
Nikanth Karthikesan <knikanth@suse.de>
Pavel Heimlich <tropikhajma@seznam.cz>
Petr Gajdos <pgajdos@suse.cz>
Sam Varshavchik <mrsam@courier-mta.com>
Serge Hallyn <serue@us.ibm.com>
Sripathi Kodi <sripathik@in.ibm.com>
Vincent Lefevre <vincent@vinc17.org>

Apologies if I missed anyone!


Web site
--------

licenses.html
    mtk
        A page describing the preferred licenses for new pages that
        are contributed to man-pages.


New and rewritten pages
-----------------------

utimensat.2
    mtk
        New page documenting the utimensat() system call, new in 2.6.22,
        and futimens() library function.

end.3
    mtk
        Documents etext, edata, and end symbols.


Newly documented interfaces in existing pages
---------------------------------------------

memchr.3
    mtk
        Add description of rawmemchr().

proc.5
    mtk
        Document /proc/config.gz (new in kernel 2.6).
    mtk, based on text from Documentation/vm/sysctl.txt
        Document /proc/sys/vm/oom_kill_allocating_task
        (new in Linux 2.6.24).
        Document /proc/sys/vm/oom_dump_tasks
        (new in Linux 2.6.25).
        Document /proc/sys/vm/panic_on_oom
        (new in Linux 2.6.18).


New links
---------

edata.3
etext.3
    mtk
        Links to end.3.

futimens.3
    mtk
        Link to new utimensat.2.

getdate_err.3
    mtk
        Link to getdate.3.

h_errno.3
    mtk
        Link to gethostbyname.3.

optarg.3
opterr.3
optind.3
optopt.3
    mtk
        Links to getopt.3.

rawmemchr.3
    mtk
        Link to memchr.3.

sys_errlist.3
sys_nerr.3
    mtk
        Links to perror.3.


Global changes
--------------

Various pages
    mtk
        s/parameter/argument/ when talking about the things given
        to a function call, for consistency with majority usage.

Various pages
    mtk
        s/UNIX/Unix/, when not used as part of a trademark,
        for consistency with majority usage in pages.

Various pages
    mtk, after a note from Alain Portal
        Put SEE ALSO entries into alphabetical order.

Various pages
    mtk
        Remove period at end of SEE ALSO list.

Various pages
    mtk, after a note by Alain Portal
        Even when the CONFORMING TO section is just a list of standards,
        they should be terminated by a period.

getpriority.2
MB_LEN_MAX.3
MB_CUR_MAX.3
fwide.3
mblen.3
rtime.3
st.4
proc.5
bootparam.7
man-pages.7
utf-8.7
tcp.5
    mtk / Alain Portal
        Small wording fixes -- express <=, <, >=, > in words when in
        running text.

sched_setparam.2
sched_setscheduler.2
getgrent_r.3
hash.3
    mtk
        Minor rewording w.r.t. use of the term "parameter".

Typographical or grammatical errors have been corrected in several
other places.  (Many, many thanks to Alain Portal!)


Changes to individual pages
---------------------------

capget.2
    Andrew Morgan
        Update in line with addition of file capabilities and
        64-bit capability sets in kernel 2.6.2[45].

clock_nanosleep.2
    mtk
        Add "Link with -lrt" to SYNOPSIS.

getrusage.2
    Sripathi Kodi
        Document RUSAGE_THREAD, new in 2.6.26.
    mtk
        Improve description of RUSAGE_CHILDREN.
        Add pointer to /proc/PID/stat in proc(5).
        Other minor clean-ups.

ioprio_set.2
    Nikanth Karthikesan
        Since Linux 2.6.25, CAP_SYS_ADMIN is longer required to set
        a low priority (IOPRIO_CLASS_IDLE).

mount.2
    mtk
        Since Linux 2.6.26, MS_RDONLY honors bind mounts.

openat.2
    mtk
        SEE ALSO: add utimensat(3).

prctl.2
    Serge Hallyn, with some edits/input from mtk
        Document PR_CAPBSET_READ and PR_CAPBSET_DROP.
    Erik Bosman
        Document PR_GET_TSC and PR_SET_TSC.
    mtk, reviewed by Andrea Arcangeli
        Document PR_SET_SECCOMP and PR_GET_SECCOMP.
    mtk
        PR_SET_KEEPCAPS and PR_GET_KEEPCAPS operate on a per-thread
        setting, not a per-process setting.
    mtk
        Clarify fork(2) details for PR_SET_PDEATHSIG.
    mtk
        Add description of PR_SET_SECUREBITS and PR_GET_SECUREBITS,
        as well as pointer to further info in capabilities(7).
    mtk
        PR_GET_ENDIAN returns endianness info in location pointed to by
        arg2 (not as function result, as was implied by previous text).
    mtk
        Expand description of PR_SET_NAME and PR_GET_NAME.
    mtk
        RETURN VALUE: bring up to date for various options.
    mtk
        Various improvements in ERRORS.
    mtk
        Note that PR_SET_TIMING setting of PR_TIMING_TIMESTAMP is not
        currently implemented.
    mtk
        Minor changes:
        * Clarify wording for PR_GET_UNALIGN, PR_GET_FPEMU, and
          PR_GET_FPEXC.
        * Some reformatting of kernel version information.
        * Reorder PR_GET_ENDIAN and PR_SET_ENDIAN entries.

readlinkat.2
    John Brooks / mtk
         Fix and reword erroneous RETURN VALUE text.

recv.2
    mtk
        Noted which flags appeared in Linux 2.2.

sched_setaffinity.2
    mtk, after a Fedora downstream patch
        Update type used for cpusetsize argument in SYNOPSIS.

select.2
    Andreas Mohr / mtk
        Clarify "zero timeout" case.
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=490868.

send.2
    mtk
        Noted which flags appeared in Linux 2.2.

sigaction.2
    mtk
        Document si_overrun and si_tid fields of siginfo structure.
        Add some text for si_trapno field.
        The si_errno field is *generally* unused.
    mtk
        Put descriptions of SA_* constants in alphabetical order.

signal.2
    mtk
        Rewrote and expanded portability discussion.
        NOTES: Show the raw prototype of signal() (without use of
        sighandler_t).

signalfd.2
    mtk
        Modify description of ssi_trapno field.

swapon.2
    mtk
        Fix two version number typos for MAX_SWAPFILES discussion:
        s/2.6.10/2.4.10/

utime.2
    mtk
         SEE ALSO: add utimensat(2), futimens(3).

dl_iterate_phdr.3
    Alain Portal
        SEE ALSO: Add elf(5).

crypt.3
    mtk, after a Fedora downstream patch
        Describe additional encryption algorithms.

errno.3
    mtk
        Small rewrites in DESCRIPTION.

exec.3
    mtk, after a note from Alain Portal
        Small rewording.

exp10.3
    Alain Portal
        SEE ALSO: Add log10(3).

exp2.3
    Alain Portal
        Add C99 to CONFORMING TO.

fgetgrent.3
    Alain Portal
        Add references to group(5).
    mtk
        Minor rewordings.
        SEE ALSO: add fopen(3).

fgetpwent.3
    Alain Portal
        Add reference to passwd(5).
    mtk
        Minor rewordings.
        SEE ALSO: add fopen(3).

frexp.3
    Alain Portal
        Add C99 to CONFORMING TO.

futimes.3
    mtk
         SEE ALSO: remove futimesat(2); add utimensat(2).

getopt.3
    mtk
        Add details on initial value of optind, and note that it can
        be reset (to 1) to restart scanning of an argument vector.
        Add a NOTES section describing the glibc-specific behavior
        when optind is reset to 0 (rather than 1).
        See http://groups.google.com/group/comp.unix.programmer/browse_thread/thread/be0d0b7a07a165fb
    mtk
        Note glibc extensions under CONFORMING TO.

getspnam.3
    mtk
        Improve comments on struct spwd.

getpw.3
    Alain Portal
        RETURN VALUE: note that errno is set on error.
    mtk
        Add EINVAL error.

insque.3
    mtk / Alain Portal
        Minor rewordings.

log.3
    Alain Portal
        Remove unnecessary sentence in ERRORS.

log10.3
    mtk
        SEE ALSO: Add exp10(3).

offsetof.3
    Alain Portal
        Small wording improvement.

pow.3
    Alain Portal
        Remove unnecessary sentence in ERRORS.

printf.3
    mtk / Alain Portal
        Many small formatting fixes.

proc.5
    mtk
        Remove redundant summary list of files in description of
        /proc/sys/kernel.
        Make kernel version for /proc/sys/kernel/panic_on_oops more precise.
        Make kernel version for /proc/sys/kernel/pid_max more precise.
        Add Documentation/sysctl/vm.txt to SEE ALSO.
        Other minor edits.

profil.3
    mtk / Alain Portal
         Small wording improvement.

rtime.3
    mtk, after a note by Alain Portal
        Clarify meaning of midnight on 1 Jan 1900/1970.
    mtk
        Remove netdate(1) and rdate(1) from SEE ALSO, since these pages
        don't seem to exist on Linux systems.

scanf.3
    Vincent Lefevre / mtk
        Clarify treatment of initial white space by %% conversion
        specification.
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=435648.
    mtk
        Many small formatting fixes.

stdin.3
    Alain Portal
        Rename CONSIDERATIONS section to NOTES, and relocate
        to appropriate place on page.

tmpfile.3
    mtk, after a note by Alain Portal
        Prepend "POSIX.1-2001 specifies that: " to the sentence stating
        that tmpfile() may write to stdout.  (AFAICS, glibc's tmpfile()
        does not do this.)

ttyname.3
    Alain Portal
        Remove unnecessary sentence in ERRORS.

wcsdup.3
    Alain Portal
        Make wording more precise: the memory allocated by wcsdup(3)
        *should* be freed with free(3).

wordexp.3
    Alain Portal / mtk
        Move example into proper EXAMPLE section.

tty_ioctl.4
    mtk / Petr Gajdos
        The features in the "Get and Set Window Size" subsection
        require the inclusion of <sys/ioctl.h>.

capabilities.7
    Serge Hallyn, plus a bit of work by mtk
        Document file capabilities, per-process capability bounding set,
        changed semantics for CAP_SETPCAP, and other changes in 2.6.2[45].
        Add CAP_MAC_ADMIN, CAP_MAC_OVERRIDE, CAP_SETFCAP.
        Various smaller fixes.
    mtk, plus review by Serge Hallyn and Andrew Morgan
        Add text detailing how CAP_SETPCAP (theoretically) permits -- on
        pre-2.6.25 kernels, and 2.6.25 and later kernels with file
        capabilities disabled -- a thread to change the capability sets
        of another thread.
        Add section describing rules for programmatically adjusting
        thread capability sets.
        Add some words describing purpose of inheritable set.
        Note existence of CONFIG_SECURITY_CAPABILITIES config option.
        Describe rationale for capability bounding set.
        Document securebits flags (new in 2.6.26).
        Remove obsolete BUGS section.
        SEE ALSO: Add getcap(8), setcap(8), and various libcap pages.
    mtk
        Add text noting that if we set the effective flag for one
        file capability, then we must also set the effective flag for all
        other capabilities where the permitted or inheritable bit is set.
    mtk
        Since Linux 2.6.25, CAP_SYS_ADMIN is no longer required for
        ioprio_set() to set IOPRIO_CLASS_IDLE class.
    mtk
        Reword discussion of CAP_LINUX_IMMUTABLE to be file-system neutral.

man-pages.7
   mtk
       A list of standards in the CONFORMING TO list should be
       terminated by a period.
       The list of pages in a SEE ALSO list should not be
       terminated by a period.

tcp.7
    mtk
        Correct a detail for sysctl_tcp_adv_win_scale.
        Formatting fixes.