1 ==================== Changes in man-pages-4.00 ====================
3 Released: ????-??-??, Munich
9 The following people contributed patches/fixes or (noted in brackets
10 in the changelog below) reports, notes, and ideas that have been
11 incorporated in changes in this release:
13 Advait Dixi <advaitdixit@hotmail.com>
14 Alain Kalker <a.c.kalker@gmail.com>
15 Andi Kleen <andi@firstfloor.org>
16 Andreas Gruenbacher <agruenba@redhat.com>
17 Andreas Heiduk <asheiduk@googlemail.com>
18 Askar Safin <safinaskar@mail.ru>
19 Brice Goglin <Brice.Goglin@inria.fr>
20 Cameron Norman <camerontnorman@gmail.com>
21 Carlos O'Donell <carlos@redhat.com>
22 Chris Metcalf <cmetcalf@tilera.com>
23 Christophe Lohr <Christophe.Lohr@telecom-bretagne.eu>
24 Christopher Head <chead@chead.ca>
25 Christoph Hellwig <hch@infradead.org>
26 David Wilcox <davidvsthegiant@gmail.com>
27 Denis Du <denisdu@ruggedcom.com>
28 Egmont Koblinger <egmont@gmail.com>
29 Filipe Brandenburger <filbranden@gmail.com>
30 Filipus Klutiero <chealer@gmail.com>
31 Florian Weimer <fweimer@redhat.com>
32 Frédéric Maria <frederic.maria@free.fr>
33 Gleb Fotengauer-Malinovskiy <glebfm@altlinux.org>
34 Graham Shaw <gdshaw@riscpkg.org>
35 Gregor Jasny <igjasny@googlemail.com>
36 Guillem Jover <guillem@hadrons.org>
37 Guy Harris <guy@alum.mit.edu>
38 Heinrich Schuchardt <xypron.glpk@gmx.de>
39 Ian Pilcher <arequipeno@gmail.com>
40 Jann Horn <jann@thejh.net>
41 Jason Newton <nevion@gmail.com>
42 J. Bruce Fields <bfields@fieldses.org>
43 Jiri Pirko <jpirko@redhat.com>
44 Joachim Wuttke <j.wuttke@fz-juelich.de>
45 Joern Heissler <contact@joern.heissler.de>
46 Jonathan Nieder <jrnieder@gmail.com>
47 Joonas Salo <salo.joonas@gmail.com>
48 Jussi Lehtola <jussilehtola@fedoraproject.org>
49 Kirill A. Shutemov <kirill.shutemov@linux.intel.com>
50 KOSAKI Motohiro <kosaki.motohiro@jp.fujitsu.com>
51 Laurence Gonsalves <laurence@xenomachina.com>
52 Magnus REFTEL <magnus.xm.reftel@stericsson.com>
53 Michael Kerrisk <mtk.manpages@gmail.com>
54 NeilBrown <neilb@suse.de>
55 Regid Ichira <regid23@nt1.in>
56 Sam Varshavchik <mrsam@courier-mta.com>
57 Steinar H. Gunderson <sgunderson@bigfoot.com>
58 Stéphane Aulery <saulery@free.fr>
59 Stephane Fillod <fillods@users.sf.net>
60 Tetsuo Handa <from-linux-kernel@i-love.sakura.ne.jp>
61 Thomas Hood <jdthood@gmail.com>
62 Urs Thuermann <urs@isnogud.escape.de>
63 Vasiliy Kulikov <segooon@gmail.com>
64 Vegard Nossum <vegard.nossum@gmail.com>
65 Weijie Yang <weijie.yang@samsung.com>
66 William Woodruff <william@tuffbizz.com>
67 Zeng Linggang <zenglg.jy@cn.fujitsu.com>
69 Apologies if I missed anyone!
72 New and rewritten pages
73 -----------------------
77 Document get_phys_pages() and get_avphys_pages()
80 Urs Thuermann, Michael Kerrisk
81 New page documenting the loop device
85 Import attr(5) man page from the 'attr' project
86 After discussions with Andreas Gruenbacher, it makes sense to
87 move this page into man-pages, since it mostly relates to
88 kernel details. Since this is an overview page,
89 we'll move it to Section 7.
92 "xattr" is a more meaningful name than "attr" (it resonates
93 with the names of the system calls), so as long as we are
94 moving the page to a new section, we'll change the name as well,
95 and retain an acl(5) link so that old references remain valid.
98 Newly documented interfaces in existing pages
99 ---------------------------------------------
102 Michael Kerrisk [Andi Kleen]
103 Document MAP_HUGE_2MB, MAP_HUGE_1GB, and MAP_HUGE_SHIFT
106 Michael Kerrisk [Andi Kleen]
107 Document SHM_HUGE_2MB, SHM_HUGE_1GB, and SHM_HUGE_SHIFT
110 Michael Kerrisk [Jonathan Nieder]
111 Add descriptions of some other resolver functions
112 Add res_ninit(), res_nquery(), res_nsearch(),
113 and res_nquerydomain(), res_nmkquery(), res_nsend().
116 Frédéric Maria [Stephane Fillod, Andreas Heiduk]
117 Document TIOCMIWAIT and TIOCGICOUNT
128 New and changed links
129 ---------------------
141 Convert to a link to printf.3
145 New link to new get_phys_pages.3 page
154 New links to resolver(3) man page
176 Tighter wording: 'mode bit' rather than 'permission bit'
177 For sticky, set-UID, and set-GID mode bits (as used in POSIX).
180 Changes to individual pages
181 ---------------------------
187 SEE ALSO: add keyrings(7)
192 SEE ALSO: add keyctl(3)
196 After EPOLLHUP, EOF will be seen only after all data has been consumed
200 Clarify that signal mask treatment in epoll_pwait() is per-thread
201 s/sigprocmask()/pthread_sigmask()/
204 Michael Kerrisk [Vegard Nossum]
205 Note an F_SETSIG corner case
207 get_mempolicy.2, set_mempolicy
209 Policy is per thread, not per process
217 Adjust "attr(5)" references to "xattr(7)"
221 SEE ALSO: add console_ioctl(2) and tty_ioctl(2)
226 Describe listxattr(2) E2BIG error and document it as a BUG
230 Wording fixes + point reader at stat(2) for explanation of file mode
231 Michael Kerrisk [Andreas Grünbacher]
232 Further tweaks to text on S_ISVTX and 'mode' argument
236 Rewordings + point reader at stat(2) for details of mode bits
240 Remove text that implies that munmap() syncs MAP_SHARED mapping to file
241 The existing text in this page:
243 MAP_SHARED Share this mapping. Updates to the mapping
244 are visible to other processes that map this
245 file, and are carried through to the underly‐
246 ing file. The file may not actually be
247 updated until msync(2) or munmap() is called.
249 implies that munmap() will sync the mapping to the underlying
250 file. POSIX doesn't require this, and some light reading of the
251 code and some light testing (fsync() after munmap() of a large
252 file) also indicates that Linux doesn't do this.
256 Rework text of DESCRIPTION
257 Rewrite the text somewhat, for easier comprehension.
258 No (intentional) changes to factual content
261 Michael Kerrisk [J. Bruce Fields]
262 Note that nfsservctl() was replaced by files in nfsd filesystem
265 Michael Kerrisk [Andreas Gruenbacher]
266 open() honors the S_ISVTX, S_ISUID, and S_ISGID bits in 'mode'
268 Tighten wording: use 'mode bit' rather than 'permission bit'
269 Michael Kerrisk [NeilBrown]
270 BUGS: O_CREAT | O_DIRECTORY succeeds if pathname does not exist
273 Michael Kerrisk [Ian Pilcher]
274 Clarify that signal mask treatment in ppoll() is per-thread
275 s/sigprocmask()/pthread_sigmask()/
276 Michael Kerrisk [Sam Varshavchik]
277 After POLLHUP, EOF will be seen only after all data has been consumed
279 Make it clearer which bits are ignored in 'events'
282 Michael Kerrisk [David Wilcox, Filipe Brandenburger]
283 Note that "parent" for purposes of PR_SET_DEATHSIG is a *thread*
284 See https://bugzilla.kernel.org/show_bug.cgi?id=43300
287 Michael Kerrisk [Jason Newton]
288 Note that sendfile does not support O_APPEND for 'out_fd'
289 See https://bugzilla.kernel.org/show_bug.cgi?id=82841
290 Michael Kerrisk [Gregor Jasny]
291 RETURN VALUE: note the possibility of "short sends"
292 See https://bugzilla.kernel.org/show_bug.cgi?id=97491
293 Michael Kerrisk [Askar Safin]
294 Clarify text on 'out_fd' and regular files in Linux 2.4
295 See https://bugzilla.kernel.org/show_bug.cgi?id=86001
298 Michael Kerrisk [Stéphane Aulery]
299 BUGS: UNIX domain sockets now detect invalid 'how' values
300 Bug fixed in Linux 3.7.
301 See https://bugzilla.kernel.org/show_bug.cgi?id=47111
305 Refer the reader to fcntl(2) F_SETSIG for further details on si_fd
309 Add note about stat() being racy
311 Improve description of some mode constants
312 Michael Kerrisk [Andreas Grünbacher]
313 Remove excessive leading zeros on some constants
315 Add text on POSIX terms "file mode bits" and "file permission bits"
316 Recent changes to various pages employ this distinction.
318 Tighten wording: use 'mode bit' rather than 'permission bit'
319 According to POSIX, the the 9 UGO*RWX bits are permissions, and
320 'mode' is used to refer to collectively to those bits plus sticky,
321 set-UID, and set_GID bits.
325 SEE ALSO: add dmesg(1)
332 Explain what default ACLs do
333 Explain the effect that default ACLs have (instead of the umask)
334 in umask.2. Mention that default ACLs can have an affect in
335 open.2, mknod.2, and mkdir.2.
338 Michael Kerrisk [Florian Weimer]
339 Give the reader a hint that unshare() works on processes or threads
340 See https://bugzilla.kernel.org/show_bug.cgi?id=59281
344 ATTRIBUTES: Note function that is thread-safe
348 ATTRIBUTES: Note function that is thread-safe
351 Michael Kerrisk [Christopher Head]
352 Fix error in SCM_RIGHTS code sample
353 Remove erroneous second initialization of msg.msg_controllen
354 in the example code for SCM_RIGHTS.
355 See https://bugzilla.kernel.org/show_bug.cgi?id=15952
359 Clarify language about "available" cpus
360 The CPU_SET.3 man page uses the adjective "available" when
361 explaining what the argument to CPU_SET() means. This is
362 confusing, since "available" isn't well-defined. The kernel
363 has a set of adjectives (possible, present, online, and active)
364 that qualify cpus, but normally none of these are what the
365 cpu_set_t bit index means: it's just "which cpu", using the
366 kernel's internal numbering system, even if that cpu isn't
369 This change removes the word "available" and adds a sentence
370 warning that cpu sets may not be contiguous due to dynamic
375 ATTRIBUTES: Note functions that are thread-safe
379 ATTRIBUTES: Note functions that are thread-safe
383 NSS plugins searched first
389 ATTRIBUTES: Note functions that are/aren't thread-safe
393 ATTRIBUTES: Note functions that are/aren't thread-safe
397 Use exit() rather than return in main()
400 Michael Kerrisk [Guy Harris]
401 Remove crufty BUGS section
402 See https://bugzilla.kernel.org/show_bug.cgi?id=90261
406 ATTRIBUTES: Note function that is thread-safe
410 ATTRIBUTES: Note function that is thread-safe
414 ATTRIBUTES: Note functions that are thread-safe
418 ATTRIBUTES: Note functions that are thread-safe
422 ATTRIBUTES: Note functions that aren't thread-safe
426 ATTRIBUTES: Note function that is thread-safe
429 Michael Kerrisk [Egmont Koblinger]
430 Merge dprintf() and vdprintf() discussion into this page
432 SEE ALSO: add puts(3)
434 Move return value discussion to proper RETURN VALUE section
438 ATTRIBUTES: Note function that is thread-safe
442 ATTRIBUTES: Note functions that are thread-safe
445 Michael Kerrisk [Laurence Gonsalves]
446 Fix error in description of 'cflags'
447 'cflags' is a bit mask of *zero* (not one) or more flags.
451 Add info about RES_INSECURE1 and RES_INSECURE2 option in debug mode
455 Improve description of %n specifier
459 ATTRIBUTES: Note functions that are thread-safe
463 ATTRIBUTES: Note function that isn't thread-safe
467 ATTRIBUTES: Note function that isn't thread-safe
471 ATTRIBUTES: Note function that isn't thread-safe
475 ATTRIBUTES: Note function that isn't thread-safe
479 ATTRIBUTES: Note function that is thread-safe
483 Remove documented functions
486 Michael Kerrisk [Denis Du]
487 Fix error in code example
490 Michael Kerrisk [Cameron Norman, Vasiliy Kulikov]
491 Document /proc mount options
492 Document the 'hidepid' and 'gid' mount options that were added in
493 Linux 3.3. See https://bugzilla.kernel.org/show_bug.cgi?id=90641
494 Based on text by Vasiliy Kulikov in
495 Documentation/filesystems/proc.txt.
496 Michael Kerrisk [Kirill A. Shutemov]
497 Improve description of /proc/PID/status
499 Document /proc/PID/exe behaviour on unlinked pathnames
500 Michael Kerrisk [Weijie Yang]
501 Document /proc/PID/status VmPMD
504 Stéphane Aulery [Thomas Hood]
505 Document use-vc option added to glibc 2.14
506 Fix Ubuntu bug #1110781:
507 https://bugs.launchpad.net/ubuntu/+source/manpages/+bug/1110781
508 Stéphane Aulery [Thomas Hood]
509 Document RES_SNGLKUPREOP
510 Fix Ubuntu bug #1110781:
511 https://bugs.launchpad.net/ubuntu/+source/manpages/+bug/1110781
515 Add various details on version 2 format
519 Add details and update URL for OLS 2003 paper on AIO
523 Document EA limits for Btrfs
524 Document VFS-imposed limits on EAs
525 VFS imposes a 255-byte limit on EA names, and a 64kB limit on
528 The ext[234] block limitation applies to sum of all EAs
529 It is not a per-EA limit.
531 Clarify permissions required to work with 'user' EAs
533 ext2 and ext3 no longer need mounting with 'user_xattr' for user EAs
535 Add various relevant pages to SEE ALSO
537 Add CONFORMING TO section
539 Modify headings to man-pages norms
541 Btrfs also supports extended attributes
543 File capabilities are implemented using *security* attributes
544 Not *system* attributes
546 Describe limit on EA values for JFS, XFS, and Reiserfs
549 Michael Kerrisk [Alain Kalker]
550 Update discussion of 'debug' option
551 See https://bugzilla.kernel.org/show_bug.cgi?id=97161
553 Summary of multiple changes: remove cruft from this page.
554 Much of the detail on hardware specifics in this page dates
555 from the 20th century. (The last major update to this page was in
556 man-pages-1.14!) It's hugely out of date now (many of these
557 devices disappeared from the kernel years ago.) So, I've taken
558 a large scythe to the page to remove anything that looks
559 seriously dated. In the process, the page has shrunk to less
560 than 50% of its previous size.
562 Remove "buff=" details
563 This seems to have gone away in Linux 2.2.
565 Remove crufty "Mouse drivers" options
567 Remove crufty "General non-device-specific boot arguments" options
569 Remove crufty "Hard disks" options
571 Remove crufty "mem=" details
573 Remove crufty details on IBM MCA bus devices
575 Remove 'swap=" details
576 This seems to have gone away in Linux 2.2,
578 Remove crufty floppy disk driver options
579 In the specific case of floppy drives: the drivers still
580 exist, but it's been a while since most of saw these devices
581 in the wild. So, just refer the reader to the kernel source
582 file for details. (The detail in this man page was after all
583 originally drawn from that file.)
584 Remove crufty "ISDN drivers" options
586 Remove crufty "line printer driver" options
588 Remove crufty "Serial port drivers" options
590 Remove crufty reference to CONFIG_BUGi386
591 That option disappeared in Linux 2.4.
594 "bootsetups array" dates from Linux 2.0.
596 Remove crufty "Video hardware" options
598 Remove crufty SCSI device driver options
601 Michael Kerrisk [Heinrich Schuchardt]
602 Since Linux 3.19, fallocate(2) generates FAN_MODIFY events
605 Michael Kerrisk [Heinrich Schuchardt]
606 Since Linux 3.19, fallocate(2) generates IN_MODIFY events
610 Explain how IP_ADD_MEMBERSHIP determines its argument type
611 Michael Kerrisk [Jiri Pirko, Magnus REFTEL]
612 Clarify details of the IP_MULTICAST_IF socket option
613 Michael Kerrisk [Advait Dixi]
614 Remove dubious text that says that SO_PRIORITY set IP TOS
615 See https://bugzilla.kernel.org/show_bug.cgi?id=35852
617 Relocate misplaced text describing ENOPROTOOPT error
621 Add sll_protocol to list of required fields for outbound packets
624 Michael Kerrisk [KOSAKI Motohiro]
625 Using thread IDs whose lifetime has expired gives undefined behavior
626 See https://bugzilla.kernel.org/show_bug.cgi?id=53061
629 Michael Kerrisk [Tetsuo Handa]
630 For incoming datagrams, sin_port is set to zero
632 Mention sendto(), recvfrom(), and so on when discussing address format
633 This gives the reader a little context for the following
634 discussion of 'sin_port'.
636 Remove crufty reference to <netinet/in.h>
638 Replace reference to RFC 1700 with pointer to IANA protocol number list
641 Michael Kerrisk [Steinar H. Gunderson]
642 Clarify that I/O operations on disks are not interrupted by signals
643 See https://bugzilla.kernel.org/show_bug.cgi?id=97721
646 Michael Kerrisk [Christophe Lohr]
647 Remove mention of UNIX_PATH_MAX
648 This kernel constant is not exposed to user space.
650 Note the 108 bytes for sun_path is how things are done on Linux
651 And refer the reader to NOTES for discussion of portability.
656 Explicitly mention some of the xattr system calls in DESCRIPTION
657 Naming the system calls helps to orient the reader
661 Add mention of 'services' and 'netgroup' databases
662 This makes the page consistent with nscd.conf(5).