2.03 initial changes

[thirdparty/man-pages.git] / Changes.old

The following are changes in previous 2.xx man page releases.

==================== Changes in man-pages-2.00 ====================

Released: 2004-12-16 (why wait for the kernel?)

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

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

Alberto Bertogli <albertogli@telpin.com.ar>
Anand Kumria <wildfire@progsoc.org>
Andrey Kiselev <dron@ak4719.spb.edu>
Andries Brouwer <Andries.Brouwer@cwi.nl>
Chris Green <cmg@dok.org>
Branden Robinson <branden@debian.org>
Emmanuel Colbus <emmanuel.colbus@ensimag.imag.fr>
Enrico Zini <enrico@debian.org>
Eric Estievenart <eric.estievenart@free.fr>
Fabian Kreutz <kreutz@dbs.uni-hannover.de>
Florian Weimer <fw@deneb.enyo.de>
Jan Kuznik <kuznik@gepro.cz>
Joey (Martin) Schulze <joey@infodrom.org>
Johannes Berg <johannes@sipsolutions.de>
John V. Belmonte <jbelmonte@debian.org>
Karel Kulhavy <clock@twibright.com>
Luis Javier Merino Morán <ljmerino@pandasoftware.es>
Martin Pool <mbp@sourcefrog.net>
Richard Kreckel <Richard.Kreckel@ginac.de>
Vasya Pupkin <ptushnik@gmail.com>

Apologies if I missed anyone!

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

Many math pages had their synopses compressed, as per suggestion
from Fabian Kreutz.

Many minor content and formatting bug fixes were made to the math
pages, following suggestions from Fabian Kreutz (who recently 
translated many of the 1.70 math pages into German) and 
Andries Brouwer.

For consistency, all instances "super-user" were changed to the more 
common "superuser".

After a note from Vasya Pupkin, I added <errno.h> to the SYNOPSIS
of several Section 2 pages using the _syscallN() macros.  

    In addition:
        -- erroneous semicolons at the end of _syscallN() were removed
           on various pages.

        -- types such as "uint" in syscalN() declarations were changed
           to "unsigned int", etc.

        -- various other minor breakages in the synopses were fixed.

   The affected pages are:

                getdents.2
                gettid.2
                llseek.2
                mmap2.2
                modify_ldt.2
                pivot_root.2
                quotactl.2
                readdir.2
                sysctl.2
                syslog.2
                tkill.2

Typographical or grammatical errors have been corrected in several
other places.

Individual pages
----------------

bind.2
    Florian Weimer
        Added 'const' to declaration of 'my_addr' in prototype.
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=239762

fcntl.2
    Martin Pool
        Added O_NOATIME to list of flags that can be changed via F_SETFL.
    mtk/aeb
        Noted F_GETOWN bug after suggestion from aeb.
        See also:
        http://marc.theaimsgroup.com/?l=linux-kernel&m=108380640603164&w=2

getrlimit.2
    mtk
        Material on getrusage.2 has been separated out into its own page.
        Rewrote discussion on RLIMIT_MEMLOCK to incorporate kernel
            2.6.9 changes.
        Added note on RLIMIT_CPU error in older kernels.
        Added RLIMIT_SIGPENDING
        Also made a few other minor changes.

getrusage.2
    mtk
        This page is new(ish) -- it was created by splitting
            getrlimit.2.

        Repaired note on SIGCHLD behaviour to note that the
            POSIX non-conformance has been fixed in 2.6.9.

kill.2
    Modified after suggestion from Emmanuel Colbus
        Changed wording of sentence under NOTES describing
            when signals can be sent to init.

mlock.2, munlock.2, mlockall.2, munlockall.2
        These have been consolidated into a single mlock.2 page.
        In the process, much duplication was eliminated
            and new information was added about RLIMIT_MEMLOCK
            and the changes in memory locking in kernel 2.6.9,

mmap.2
    mtk
        Added cross-ref to setrlimit(2) concerning memory locking limits.
    Eric Estievenart
        Note that MAP_FIXED replaces existing mappings

msgctl.2
   mtk
        Substantial language and formatting clean-ups.
        Added msqid_ds and ipc_perm structure definitions.

msgget.2
   mtk
        Substantial language and formatting clean-ups.
        Added notes on /proc files.

msgop.2
   mtk
        Substantial language and formatting clean-ups.
        Added notes on /proc files.

open.2
    Martin Pool
        Added O_NOATIME (new in Linux 2.6.8)
    mtk
        Reordered list of 'flags' description alphabetically

personality.2
   2004-11-03 applied patch from Martin Schulze

semctl.2
   mtk
        Substantial language and formatting clean-ups.
        Rewrote semun text.
        Added semid_ds and ipc_perm structure definitions.

semget.2
   mtk
        Substantial language and formatting clean-ups.
        Added notes on /proc files.
        Rewrote BUGS note about semget()'s failure to initialise
            semaphore values.

semop.2
   mtk
        Substantial language and formatting clean-ups.
        Added notes on /proc files.

shmctl.2
   mtk
        Substantial language and formatting clean-ups.
        Updated shmid_ds structure definitions.
        Added information on SHM_DEST and SHM_LOCKED flags.
        Noted that CAP_IPC_LOCK is not required for SHM_UNLOCK
            since kernel 2.6.9.
        Added notes on 2.6.9 RLIMIT_MEMLOCK changes.
        Added RLIMIT_SIGPENDING (new in Linux 2.6.8)

shmget.2
   mtk
        Substantial language and formatting clean-ups.
        Added notes on /proc files.

shmop.2
   mtk
        Substantial language and formatting clean-ups.
        Changed wording and placement of sentence regarding attachment
            of segments marked for destruction.

sigaction.2
   mtk
        Added mention of SIGCONT under SA_NOCLDSTOP.
        Added SA_NOCLDWAIT.
        Updated discussion for POSIX.1-2001 and SIGCHLD and sa_flags.
        Noted that CLD_CONTINUED is supported since Linux 2.6.9.
        Added SI_TKILL (new in Linux 2.4.19).
        Other minor changes.

signal.2
    mtk
        Removed text on ignoring SIGCHLD; replaced with pointer 
            to sigaction.2.

sigwaitinfo.2
    After bug report from Andrey Kiselev
        Fixed prototype: "timeout" --> "*timeout"
        as per: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=222145

stat,2
    Enrico Zini
        Added text to clarify that S_IS*() macros should be applied to 
        st_mode field.
        as per: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=249698

swapon.2
    After bug report from Anand Kumria
        Added "no swap space signature" to EINVAL error
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi
    mtk
        Added EINVAL error for swapoff() ("not currently a swap area").
        Added EBUSY error for swapon().
        A few formatting fixes.

times.2
    mtk
        In Linux 2.6, the return value of times changed; it is no 
            longer time since boot, but rather:

                boot_time + 2^32 / HZ - 300

        Repaired note on SIGCHLD behaviour to note that the
            POSIX non-conformance has been fixed in 2.6.9.
        Some formatting fixes.

undocumented.2
    After bug report from Johannes Berg
        Changed
            .TH UNIMPLEMENTED
        to:
            .TH UNDOCUMENTED
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=220741

wait.2
    mtk
        Added waitid(2).
        Added WCONTINUED and WIFCONTINUED (new in 2.6.10).
        Added text on SA_NOCLDSTOP.
        Updated discussion of SA_NOCLDWAIT to reflect 2.6 behaviour.
        Much other text rewritten.

wait4.2
    mtk
        Rewrote this page, removing much duplicated information,
            and replacing with pointers to wait.2.
    Luis Javier Merino Morán / mtk
        CONFORMING TO said "SVr4, POSIX".  Changed to "4.3BSD"

waitid.2
    mtk
        New link to wait.2

assert.3
    After bug report from Branden Robinson
        The assert() failure message goes to stderr not stdout.
        As per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=284814
        
ctime.3
    mtk
        Noted that 0 in tm_mday is interpreted to mean the last day 
            of the preceding month.

getnameinfo.3
    http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=229618
        getnameinfo() does not set errno, it returns a non-zero
        value indicating the error.
    mtk
        added EAI_OVERFLOW error

killpg.3
    mtk
        Minor changes to SEE ALSO and CONFORMING TO.

lseek64.3
    aeb
        New page by Andries Brouwer

tzset.3
    Richard Kreckel
        Change "NULL" to "empty" when talking about the value of TZ.
        http://sources.redhat.com/bugzilla/show_bug.cgi?id=601

printf.3
    After bug report from Jan Kuznik 
        http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=205736
        Fixed bad realloc() use in snprintf() example

random.4
    After bug report from John V. Belmonte
        Updated init and quit scripts to reflect kernel 2.4/2.6 reality
        (Scripts taken from drivers/char/random.c)
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=247779

proc.5
    mtk
        Updated description of /proc/loadavg to include
            nr_running(), nr_threads, last_pid.

        rtsig-max and rtsig-nr went away in 2.6.8

        updated statm, and fixed error in order of list

realpath.3
    mtk
        Added discussion of resolved_path == NULL.

boot.7
    applied patch from Martin Schulze

capabilities.7
    mtk
        Added O_NOATIME for CAP_FOWNER

netdevice.7 
    Karel Kulhavy and AEB
        formatting fix after note from Karel Kulhavy and AEB, plus a 
            few wording fixes.
   
signal.7
    mtk
        /proc/sys/kernel/rtsig-* were superceded by RLIMIT_SIGPENDING
            in kernel 2.6.8.
            
tcp.7
   mtk/aeb
        Updated details of interaction of TCP_CORK and TCP_NODELAY.

==================== Changes in man-pages-2.01 ====================

Released: 2004-12-20 (a quick one before Christmas)

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

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

Carsten Hey <c.hey@web.de>
Johannes Berg <johannes@sipsolutions.de>
Joshua Kwan <joshk@triplehelix.org>
Marek Habersack <grendel@debian.org>
Martin Schulze <joey@infodrom.org>
Matthew Dempsky <jivera@flame.org>
Matthew Gregan <kinetik@orcon.net.nz>
Pedro Zorzenon Neto <pzn@terra.com.br>
Tony Crawford <tony@klosterdorf.de>

Apologies if I missed anyone!

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

Matthew Dempsky, mtk
    triggered by http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=283179
    The wording describing how errno is set was fixed up in the
    following pages:

            accept.2
            close.2
            send.2
            setsid.2
            socket.2
            closedir.3
            initgroups.3
            mkstemp.3
            opendir.3
            readdir.3
            telldir.3

Typographical or grammatical errors have been corrected in several
other places.

Individual pages
----------------

sendfile.2
    mtk
        Adjusted descriptions of argument file types to be closer to 
            2.6 reality.
        Wording and formatting changes

ctan.3
ctanh.3
    Tony Crawford
        As per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=270817
        Formulae on the pages should be T = S / C not T = C / S.

errno.3
    Martin Schulze, mtk
        Removed errno declaration from prototype, added notes
            on historical need for this declaration.
        http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=174175

aio_return.3
   as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=224953
       Changed erroneous "aio_return(2)" to "aio_return(3)"

posix_openpt.3
    mtk
        New by mtk

ptsname.3
    mtk
        Added description of ptsname_r().
        Added ERRORS.

ptsname_r.3
    mtk
        New link to ptsname.3.

shm_open.3
    Matthew Gregan
        add <fcntl.h> to synopsis
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=271243

strcasecmp.3
    Marek Habersack <grendel@debian.org>
            .SH "CONFORMING TO"
            -BSD 4.4
            +BSD 4.4, SUSv3
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=234443
        
strfry.3
    Joshua Kwan
        Added _GNU_SOURCE to prototype
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=213538
                
strftime.3
    Cartsen Hey
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=276248

        Changed range for "%S" from 0..61 to 0..0.

        SUSv3 says 0..60.  I think the manual page probably says 
        0..61, because that's what SUSv2 said.
        (Some other implementations' man pages also say 0..61 -- 
        e.g., Solaris 8 & 9, Tru64 5.1B; FreeBSD 5.1 says 0..60.)

        The glibc manual currently says 0..60.

        Given that SUSv3 says 0..60, I've changed the 
        manual page to also say this:

            -The second as a decimal number (range 00 to 61).
            +The second as a decimal number (range 00 to 60).
            +(The range is up to 60 to allow for occasional leap seconds.)

sysconf.3
    Johannes Berg / http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=226974
        -.BR POSIX2_FORT_RUN " - " _SC_2_FORT_DEV
        +.BR POSIX2_FORT_DEV " - " _SC_2_FORT_DEV

system.3
    Pedro Zorzenon 
        as per http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=242638
        Noted use of _XOPEN_SOURCE to get macros <sytdlib.h> 
        as for wait(2).

    mtk
        Changed name of argument from 'string' to 'command' (like POSIX).

        Noted that glibc does nowadays explicitly check for the existence
        of the shell if 'command' is NULL, rather than the older behaviour
        of assuming the shell exists and always returning 1 if
        'command' is NULL.

        Other wording and formatting clean-ups.

undocumented.3
    Remove some functions names that *are* documented.