]> git.ipfire.org Git - thirdparty/man-pages.git/blob - Changes
Changes: Ready for 4.00
[thirdparty/man-pages.git] / Changes
1 ==================== Changes in man-pages-4.00 ====================
2
3 Released: ????-??-??, Munich
4
5
6 Contributors
7 ------------
8
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:
12
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>
68
69 Apologies if I missed anyone!
70
71
72 New and rewritten pages
73 -----------------------
74
75 get_phys_pages.3
76 William Woodruff
77 Document get_phys_pages() and get_avphys_pages()
78
79 loop.4
80 Urs Thuermann, Michael Kerrisk
81 New page documenting the loop device
82
83 xattr.7
84 Andreas Gruenbacher
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.
90 Michael Kerrisk
91 Rename page
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.
96
97
98 Newly documented interfaces in existing pages
99 ---------------------------------------------
100
101 mmap.2
102 Michael Kerrisk [Andi Kleen]
103 Document MAP_HUGE_2MB, MAP_HUGE_1GB, and MAP_HUGE_SHIFT
104
105 shmget.2
106 Michael Kerrisk [Andi Kleen]
107 Document SHM_HUGE_2MB, SHM_HUGE_1GB, and SHM_HUGE_SHIFT
108
109 resolver.3
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().
114
115 tty_ioctl.4
116 Frédéric Maria [Stephane Fillod, Andreas Heiduk]
117 Document TIOCMIWAIT and TIOCGICOUNT
118 Michael Kerrisk
119 Document TIOCGEXCL
120 Michael Kerrisk
121 Document TIOGCPKT
122 Michael Kerrisk
123 Document TIOCSPTLCK
124 Michael Kerrisk
125 Document TIOCGPTLCK
126
127
128 New and changed links
129 ---------------------
130
131 CMSG_DATA.3
132 Michael Kerrisk
133 New link to cmsg(3)
134
135 CMSG_LEN.3
136 Michael Kerrisk
137 New link to cmsg(3)
138
139 dprintf.3
140 Michael Kerrisk
141 Convert to a link to printf.3
142
143 get_avphys_pages.3
144 William Woodruff
145 New link to new get_phys_pages.3 page
146
147 res_ninit.3
148 res_nmkquery.3
149 res_nquery.3
150 res_nquerydomain.3
151 res_nsearch.3
152 res_nsend.3
153 Michael Kerrisk
154 New links to resolver(3) man page
155
156 loop-control.4
157 Michael Kerrisk
158 New link to loop.4
159
160 attr.5
161 Michael Kerrisk
162 New link to xattr(7)
163
164
165 Global changes
166 --------------
167
168 chown.2
169 execve.2
170 prctl.2
171 truncate.2
172 proc.5
173 capabilities.7
174 ld.so.8
175 Michael Kerrisk
176 Tighter wording: 'mode bit' rather than 'permission bit'
177 For sticky, set-UID, and set-GID mode bits (as used in POSIX).
178
179
180 Changes to individual pages
181 ---------------------------
182
183 add_key.2
184 keyctl.2
185 request_key.2
186 Michael Kerrisk
187 SEE ALSO: add keyrings(7)
188
189 add_key.2
190 request_key.2
191 Michael Kerrisk
192 SEE ALSO: add keyctl(3)
193
194 epoll_ctl.2
195 Michael Kerrisk
196 After EPOLLHUP, EOF will be seen only after all data has been consumed
197
198 epoll_wait.2
199 Michael Kerrisk
200 Clarify that signal mask treatment in epoll_pwait() is per-thread
201 s/sigprocmask()/pthread_sigmask()/
202
203 fcntl.2
204 Michael Kerrisk [Vegard Nossum]
205 Note an F_SETSIG corner case
206
207 get_mempolicy.2, set_mempolicy
208 Brice Goglin
209 Policy is per thread, not per process
210
211 getxattr.2
212 listxattr.2
213 removexattr.2
214 setxattr.2
215 capabilities.7
216 Michael Kerrisk
217 Adjust "attr(5)" references to "xattr(7)"
218
219 ioctl.2
220 Michael Kerrisk
221 SEE ALSO: add console_ioctl(2) and tty_ioctl(2)
222
223 listxattr.2
224 xattr.7
225 Michael Kerrisk
226 Describe listxattr(2) E2BIG error and document it as a BUG
227
228 mkdir.2
229 Michael Kerrisk
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
233
234 mknod.2
235 Michael Kerrisk
236 Rewordings + point reader at stat(2) for details of mode bits
237
238 mmap.2
239 Michael Kerrisk
240 Remove text that implies that munmap() syncs MAP_SHARED mapping to file
241 The existing text in this page:
242
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.
248
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.
253
254 msync.2
255 Michael Kerrisk
256 Rework text of DESCRIPTION
257 Rewrite the text somewhat, for easier comprehension.
258 No (intentional) changes to factual content
259
260 nfsservctl.2
261 Michael Kerrisk [J. Bruce Fields]
262 Note that nfsservctl() was replaced by files in nfsd filesystem
263
264 open.2
265 Michael Kerrisk [Andreas Gruenbacher]
266 open() honors the S_ISVTX, S_ISUID, and S_ISGID bits in 'mode'
267 Michael Kerrisk
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
271
272 poll.2
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
278 Michael Kerrisk
279 Make it clearer which bits are ignored in 'events'
280
281 prctl.2
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
285
286 sendfile.2
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
296
297 shutdown.2
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
302
303 sigaction.2
304 Michael Kerrisk
305 Refer the reader to fcntl(2) F_SETSIG for further details on si_fd
306
307 stat.2
308 Jann Horn
309 Add note about stat() being racy
310 Andreas Gruenbacher
311 Improve description of some mode constants
312 Michael Kerrisk [Andreas Grünbacher]
313 Remove excessive leading zeros on some constants
314 Michael Kerrisk
315 Add text on POSIX terms "file mode bits" and "file permission bits"
316 Recent changes to various pages employ this distinction.
317 Michael Kerrisk
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.
322
323 syslog.2
324 Michael Kerrisk
325 SEE ALSO: add dmesg(1)
326
327 umask.2
328 open.2
329 mknod.2
330 mkdir.2
331 Andreas Gruenbacher
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.
336
337 unshare.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
341
342 atexit.3
343 Zeng Linggang
344 ATTRIBUTES: Note function that is thread-safe
345
346 bsearch.3
347 Zeng Linggang
348 ATTRIBUTES: Note function that is thread-safe
349
350 cmsg.3
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
356
357 CPU_SET.3
358 Chris Metcalf
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
367 possible or present.
368
369 This change removes the word "available" and adds a sentence
370 warning that cpu sets may not be contiguous due to dynamic
371 cpu hotplug, etc.
372
373 err.3
374 Zeng Linggang
375 ATTRIBUTES: Note functions that are thread-safe
376
377 ftw.3
378 Zeng Linggang
379 ATTRIBUTES: Note functions that are thread-safe
380
381 gethostbyname.3
382 Carlos O'Donell
383 NSS plugins searched first
384 Carlos O'Donell
385 "order" is obsolete
386
387 gethostid.3
388 Zeng Linggang
389 ATTRIBUTES: Note functions that are/aren't thread-safe
390
391 getmntent.3
392 Zeng Linggang
393 ATTRIBUTES: Note functions that are/aren't thread-safe
394
395 get_nprocs_conf.3
396 Michael Kerrisk
397 Use exit() rather than return in main()
398
399 getopt.3
400 Michael Kerrisk [Guy Harris]
401 Remove crufty BUGS section
402 See https://bugzilla.kernel.org/show_bug.cgi?id=90261
403
404 iconv_close.3
405 Zeng Linggang
406 ATTRIBUTES: Note function that is thread-safe
407
408 inet_ntop.3
409 Zeng Linggang
410 ATTRIBUTES: Note function that is thread-safe
411
412 longjmp.3
413 Zeng Linggang
414 ATTRIBUTES: Note functions that are thread-safe
415
416 lsearch.3
417 Zeng Linggang
418 ATTRIBUTES: Note functions that are thread-safe
419
420 mcheck.3
421 Zeng Linggang
422 ATTRIBUTES: Note functions that aren't thread-safe
423
424 on_exit.3
425 Zeng Linggang
426 ATTRIBUTES: Note function that is thread-safe
427
428 printf.3
429 Michael Kerrisk [Egmont Koblinger]
430 Merge dprintf() and vdprintf() discussion into this page
431 Michael Kerrisk
432 SEE ALSO: add puts(3)
433 Michael Kerrisk
434 Move return value discussion to proper RETURN VALUE section
435
436 putpwent.3
437 Zeng Linggang
438 ATTRIBUTES: Note function that is thread-safe
439
440 qsort.3
441 Zeng Linggang
442 ATTRIBUTES: Note functions that are thread-safe
443
444 regex.3
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.
448
449 resolver.3
450 Stéphane Aulery
451 Add info about RES_INSECURE1 and RES_INSECURE2 option in debug mode
452
453 scanf.3
454 Joern Heissler
455 Improve description of %n specifier
456
457 setjmp.3
458 Zeng Linggang
459 ATTRIBUTES: Note functions that are thread-safe
460
461 setlocale.3
462 Zeng Linggang
463 ATTRIBUTES: Note function that isn't thread-safe
464
465 setlogmask.3
466 Zeng Linggang
467 ATTRIBUTES: Note function that isn't thread-safe
468
469 sleep.3
470 Zeng Linggang
471 ATTRIBUTES: Note function that isn't thread-safe
472
473 strsignal.3
474 Zeng Linggang
475 ATTRIBUTES: Note function that isn't thread-safe
476
477 sysconf.3
478 Zeng Linggang
479 ATTRIBUTES: Note function that is thread-safe
480
481 undocumented.3
482 William Woodruff
483 Remove documented functions
484
485 tty_ioctl.4
486 Michael Kerrisk [Denis Du]
487 Fix error in code example
488
489 proc.5
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
498 Guillem Jover
499 Document /proc/PID/exe behaviour on unlinked pathnames
500 Michael Kerrisk [Weijie Yang]
501 Document /proc/PID/status VmPMD
502
503 resolv.conf.5
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
512
513 tzfile.5
514 Sam Varshavchik
515 Add various details on version 2 format
516
517 aio.7
518 Michael Kerrisk
519 Add details and update URL for OLS 2003 paper on AIO
520
521 xattr.7
522 Michael Kerrisk
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
526 EA values.
527 Michael Kerrisk
528 The ext[234] block limitation applies to sum of all EAs
529 It is not a per-EA limit.
530 Michael Kerrisk
531 Clarify permissions required to work with 'user' EAs
532 Michael Kerrisk
533 ext2 and ext3 no longer need mounting with 'user_xattr' for user EAs
534 Michael Kerrisk
535 Add various relevant pages to SEE ALSO
536 Michael Kerrisk
537 Add CONFORMING TO section
538 Michael Kerrisk
539 Modify headings to man-pages norms
540 Michael Kerrisk
541 Btrfs also supports extended attributes
542 Michael Kerrisk
543 File capabilities are implemented using *security* attributes
544 Not *system* attributes
545 Michael Kerrisk
546 Describe limit on EA values for JFS, XFS, and Reiserfs
547
548 bootparam.7
549 Michael Kerrisk [Alain Kalker]
550 Update discussion of 'debug' option
551 See https://bugzilla.kernel.org/show_bug.cgi?id=97161
552 Michael Kerrisk
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.
561 Michael Kerrisk
562 Remove "buff=" details
563 This seems to have gone away in Linux 2.2.
564 Michael Kerrisk
565 Remove crufty "Mouse drivers" options
566 Michael Kerrisk
567 Remove crufty "General non-device-specific boot arguments" options
568 Michael Kerrisk
569 Remove crufty "Hard disks" options
570 Michael Kerrisk
571 Remove crufty "mem=" details
572 Michael Kerrisk
573 Remove crufty details on IBM MCA bus devices
574 Michael Kerrisk
575 Remove 'swap=" details
576 This seems to have gone away in Linux 2.2,
577 Michael Kerrisk
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
585 Michael Kerrisk
586 Remove crufty "line printer driver" options
587 Michael Kerrisk
588 Remove crufty "Serial port drivers" options
589 Michael Kerrisk
590 Remove crufty reference to CONFIG_BUGi386
591 That option disappeared in Linux 2.4.
592 Michael Kerrisk
593 Remove crufty text
594 "bootsetups array" dates from Linux 2.0.
595 Michael Kerrisk
596 Remove crufty "Video hardware" options
597 Michael Kerrisk
598 Remove crufty SCSI device driver options
599
600 fanotify.7
601 Michael Kerrisk [Heinrich Schuchardt]
602 Since Linux 3.19, fallocate(2) generates FAN_MODIFY events
603
604 inotify.7
605 Michael Kerrisk [Heinrich Schuchardt]
606 Since Linux 3.19, fallocate(2) generates IN_MODIFY events
607
608 ip.7
609 Michael Kerrisk
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
616 Michael Kerrisk
617 Relocate misplaced text describing ENOPROTOOPT error
618
619 packet.7
620 Graham Shaw
621 Add sll_protocol to list of required fields for outbound packets
622
623 pthreads.7
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
627
628 raw.7
629 Michael Kerrisk [Tetsuo Handa]
630 For incoming datagrams, sin_port is set to zero
631 Michael Kerrisk
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'.
635 Michael Kerrisk
636 Remove crufty reference to <netinet/in.h>
637 Michael Kerrisk
638 Replace reference to RFC 1700 with pointer to IANA protocol number list
639
640 signal.7
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
644
645 unix.7
646 Michael Kerrisk [Christophe Lohr]
647 Remove mention of UNIX_PATH_MAX
648 This kernel constant is not exposed to user space.
649 Michael Kerrisk
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.
652
653
654 xattr.7
655 Michael Kerrisk
656 Explicitly mention some of the xattr system calls in DESCRIPTION
657 Naming the system calls helps to orient the reader
658
659 nscd.8
660 Michael Kerrisk
661 Add mention of 'services' and 'netgroup' databases
662 This makes the page consistent with nscd.conf(5).