Commit Graph

9425 Commits

Author SHA1 Message Date
Michael Kerrisk dd827c27b0 string.3: Fixes and enhancements to Moritz Str?be's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-05 00:34:01 +13:00
Moritz 'Morty' Strübe 0612e12ee7 string.3: Add short description of the functions
It is helpful to have a short description about what the different
functions in string.h do.

Signed-off-by: Moritz 'Morty' Strübe <morty@gmx.net>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-04 23:20:02 +13:00
Michael Kerrisk aa89a58e5a man-pages.7: Minor fixes
Reported-by: Bert Wesarg <bert.wesarg@googlemail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-04 00:42:09 +13:00
Michael Kerrisk 7849287b90 man-pages.7: Add STYLE GUIDE section
Incorporate some of the existing material in the page
into the STYLE GUIDE, and add a lot more material, mainly
drawn from the "Global changes" sections in the release
changelogs.

Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:48:48 +13:00
Michael Kerrisk b437fdd90a epoll_ctl.2, execve.2, recv.2, timer_create.2, wait.2, argz_add.3, basename.3, dlopen.3, exec.3, fopencookie.3, fts.3, getaddrinfo.3, getcwd.3, gethostbyname.3, getifaddrs.3, getipnodebyname.3, getlogin.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, getusershell.3, glob.3, if_nameindex.3, inet_ntop.3, lio_listio.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mq_notify.3, ptsname.3, realpath.3, setnetgrent.3, sigvec.3, strsignal.3, strtok.3, wcrtomb.3, wcsnrtombs.3, wcsrtombs.3, wcstombs.3, xdr.3: Global fix of "NULL pointer"
Change "NULL pointer: to "NUL " or null pointer".
POSIX uses the term "null pointer", not "NULL pointer".

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:06 +13:00
Michael Kerrisk efb12489de exec.3, fts.3: srcfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:06 +13:00
Michael Kerrisk 080e003557 hpsa.4: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:06 +13:00
Michael Kerrisk 03407e3388 termios.3: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:05 +13:00
Michael Kerrisk 7d182bb660 perf_event_open.2: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:05 +13:00
Michael Kerrisk 246414a67a mtrace.3: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:05 +13:00
Michael Kerrisk 3a935ca8a4 fts.3: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 15:47:05 +13:00
Michael Kerrisk f78f2def0f man-pages.7: Add some further style notes for code examples
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 12:34:35 +13:00
Michael Kerrisk fa797358b5 INFINITY.3: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:29:37 +13:00
Michael Kerrisk 314ef95df4 prctl.2: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:26:45 +13:00
Michael Kerrisk 4651e41294 perf_event_open.2: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:19:25 +13:00
Michael Kerrisk 1b0892e8c3 mallopt.3: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:16:54 +13:00
Michael Kerrisk 850905cf88 clone.2: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:13:23 +13:00
Michael Kerrisk f7407651f6 capabilities.7: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:11:34 +13:00
Michael Kerrisk 9e802a1f57 spu_create.2: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:08:16 +13:00
Michael Kerrisk 91e4f66067 man-pages.7: Add historical note on reason for use of Americal spelling
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:04:39 +13:00
Michael Kerrisk 1080506334 man-pages.7: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 10:02:29 +13:00
Michael Kerrisk 4318a7d0f5 dlopen.3: Minor fixes
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 09:58:37 +13:00
Michael Kerrisk dd6b62ec6e vdso.7: Minor fixes
Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 08:12:10 +13:00
Michael Kerrisk 5e0622bad2 dlopen.3: srcfix: add a reference to Austin "Pointer Types" issue
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 23:14:28 +13:00
Michael Kerrisk daf28a2b22 dlopen.3: Tweaks to previous patch
Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 22:34:20 +13:00
Michael Kerrisk 65d28e9870 standards.7: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 14:45:57 +13:00
Michael Kerrisk 299653455f dlopen.3: Update remarks on cast needed when assigning dlsym() return value
POSIX.1-2013 eases life when casting the dlsym() return value to a
function pointer

Reported-by: Mike Frysinger <vapier@gentoo.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 14:42:09 +13:00
Mike Frysinger a9deb5e056 ptrace.2: tfix userspace->user space
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Mike Frysinger 951ae9c063 syscall.2, syscalls.2, getauxval.3: Add references to new vdso(7) page
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Mike Frysinger 8e30d5ac23 libc.7: SEE ALSO: add various entries
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 8635ed1b99 vdso.7: srcfix: wrap some long source lines
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk f6816de988 vdso.7: Further tweaks after discussion with Mike Frysinger
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk fb634bd8da vdso.7: Clean-ups
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Mike Frysinger 2800db8247 vdso.7: New page documenting the vDSO mapped into each process by the kernel
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 10850212d0 uselib.2, getfsent.3, regex.3, nsswitch.conf.5, inotify.7, man-pages.7, symlink.7: Replace uses of "e.g." in main text with "for example" or similar
Usual man-pages style is to use "e.g." only within
    parenthetical expressions.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 449dd4e2ab proc.5, unix.7: grfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 88879aebdd eventfd.2, set_mempolicy.2, timerfd_create.2, fwide.3, resolver.3, spufs.7, symlink.7, udplite.7, unicode.7: Replace uses of "i.e.," in main text with "that is" or similar
Usual man-pages style is to use "i.e." only within
parenthetical expressions.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 5aecfe9017 puts.3: SEE ALSO: replace reference to gets(3) with fgets(3)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk d098e934d0 getline.3: Remove SEE ALSO reference to unsafe gets(3)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk d4df4e8ad4 fgetc.3: Minor fix to ordering in SEE ALSO
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 7e2b0db30f gets.3: Tweaks to David Malcolm's patch
Reported-by: Andre Majorel <aym-xunil@teaser.fr>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk a5539262a5 gets.3: Tweaks to David Malcolm's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 42818f2072 fgetc.3, gets.3: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 845f05b519 fgets.3, getc.3, getchar.3, ungetc.3: Adjust links to gets(3) to point to fgetc(3)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
David Malcolm beef277092 fgetc.3, gets.3: Split gets(3) to isolate unsafe gets(3) to a page on its own
Currently man3/gets.3 documents various safe I/O functions, along
with the toxic "gets" function.

At the risk of being melodramatic, this strikes me as akin to
storing rat poison in a food cabinet, in the same style of
packaging as the food, but with a post-it note on it saying
"see warnings below".

I think such "never use this" functions should be quarantined
into their own manpages, rather than listing them alongside
sane functions.

The attached patch does this for "gets", moving the documentation
of the good functions from man3/gets.3 into man3/fgetc.3,
updating the SO links in the relevant functions to point at the
latter.

It then rewrites man3/gets.3 to spell out that "gets" is toxic
and should never be used (with a link to CWE-242 for good
measure).

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 2c212ccda9 socket.7: wfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk d332f86f5a socket.2: Remove crufty statement that AF_INET does not support SOCK_SEQPACKET
Linux AF_INET supports SOCK_SEQPACKET via SCTP.

Reported-by: Dongsheng Song <dongsheng.song@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 33da1b0606 Changes: Add dedication
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:16 +13:00
Michael Kerrisk 445319fd4a close.2: Note that errors from close() should be used only for diagnosis
In particular, retrying after EINTR is a bad idea.

See http://austingroupbugs.net/view.php?id=529

See http://thread.gmane.org/gmane.comp.lib.glibc.alpha/37702
Subject: [RFC][BZ #14627] Make linux close errno to EINPROGRESS
         when interrupted in signal.

Reported-by: P?draig Brady <P@draigBrady.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:15 +13:00
Michael Kerrisk 8a7ac774ba strspn.3: Improve description in NAME
See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=723659

Reported-by: Mathieu Malaterre <malat@debian.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-02 11:49:15 +13:00