Changes

   1 ==================== Changes in man-pages-4.13 ====================
   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 Aleksa Sarai <asarai@suse.de>
  14 Alex Henrie <alexhenrie24@gmail.com>
  15 Benjamin Peterson <bp@benjamin.pe>
  16 Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
  17 Cyrill Gorcunov <gorcunov@openvz.org>
  18 Darrick J. Wong <darrick.wong@oracle.com>
  19 David Wilder <dwilder@us.ibm.com>
  20 Dennis Knorr <dennis.knorr@muenchen.de>
  21 Don Brace <don.brace@microsemi.com>
  22 Douglas Caetano dos Santos <douglascs@taghos.com.br>
  23 Elliott Hughes <enh@google.com>
  24 Eugene Syromyatnikov <evgsyr@gmail.com>
  25 Fabio Scotoni <fabio@esse.ch>
  26 Florian Weimer <fweimer@redhat.com>
  27 Jakub Wilk <jwilk@jwilk.net>
  28 Jason Noakes <jjnoakes@gmail.com>
  29 Jens Axboe <axboe@kernel.dk>
  30 Jonas Grabber <jobegrabber@gmail.com>
  31 Kees Cook <keescook@chromium.org>
  32 Konstantin Shemyak <konstantin@shemyak.com>
  33 Li Zhijian <lizhijian@cn.fujitsu.com>
  34 Marko Myllynen <myllynen@redhat.com>
  35 Mark Wielaard <mark@klomp.org>
  36 Meelis Roos <mroos@linux.ee>
  37 Michael Kerrisk <mtk.manpages@gmail.com>
  38 Mike Rapoport <rppt@linux.vnet.ibm.com>
  39 NeilBrown <neilb@suse.com>
  40 Otto Ebeling <oebeling@github.mail.kapsi.fi>
  41 Paul Eggert <eggert@cs.ucla.edu>
  42 Rick Jones <rick.jones2@hpe.com>
  43 Sage Weil <sage@redhat.com>
  44 Sam Varshavchik <mrsam@courier-mta.com>
  45 Sergey Z. <zhurxx@gmail.com>
  46 Shrikant Giridhar <shrikantgiridhar@gmail.com>
  47 Stephan Müller <smueller@chronox.de>
  48 Sukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
  49 Tej Chajed <tchajed@mit.edu>
  50 Thiago Jung Bauermann <bauerman@linux.vnet.ibm.com>
  51 Vincent Bernat <vincent@bernat.im>
  52 Yubin Ruan <ablacktshirt@gmail.com>
  53 Ильдар Низамов <niya3@mail.ru>
  54
  55 Apologies if I missed anyone!
  56
  57
  58 New and rewritten pages
  59 -----------------------
  60
  61 pthread_mutex_consistent.3
  62     Yubin Ruan, Michael Kerrisk
  63         New page documenting pthread_mutex_consistent(3)
  64
  65 pthread_mutexattr_getpshared.3
  66     Michael Kerrisk
  67         New page for pthread_mutexattr_getpshared(3) and pthread_mutexattr_setpshared(3)
  68
  69 pthread_mutexattr_init.3
  70     Michael Kerrisk
  71         New page for pthread_mutexattr_init(3) and pthread_mutexattr_destroy(3)
  72
  73 pthread_mutexattr_setrobust.3
  74     Yubin Ruan, Michael Kerrisk
  75         New page for pthread_mutexattr_setrobust(3) and pthread_mutexattr_getrobust(3)
  76
  77 sysfs.5
  78     Michael Kerrisk  [Mark Wielaard]
  79         New page documenting the sysfs filesystem
  80             Just a skeleton page so far, but perhaps it will be filled out
  81             over time.
  82
  83
  84 Newly documented interfaces in existing pages
  85 ---------------------------------------------
  86
  87 fcntl.2
  88     Jens Axboe, Michael Kerrisk
  89         Describe the set/get write hints commands that are added in Linux 4.13
  90             Document F_GET_RW_HINT, F_SET_RW_HINT, F_GET_FILE_RW_HINT, and
  91             F_SET_FILE_RW_HINT.
  92
  93 ioctl_tty.2
  94     Aleksa Sarai, Michael Kerrisk
  95         Add TIOCGPTPEER documentation
  96
  97 kcmp.2
  98     Cyrill Gorcunov
  99         Add KCMP_EPOLL_TFD description
 100
 101 keyctl.2
 102     Eugene Syromyatnikov
 103         Document the KEYCTL_RESTRICT_KEYRING operation
 104     Eugene Syromyatnikov  [Stephan Müller]
 105         Document the ability to provide KDF parameters in KEYCTL_DH_COMPUTE
 106
 107
 108 New and changed links
 109 ---------------------
 110
 111 pthread_mutexattr_destroy.3
 112     Michael Kerrisk
 113         New link to new pthread_mutexattr_init.3 page
 114
 115 pthread_mutexattr_getrobust.3
 116     Michael Kerrisk
 117         New link to new pthread_mutexattr_setrobust.3 page
 118
 119 pthread_mutexattr_getrobust_np.3
 120     Michael Kerrisk
 121         New link to new pthread_mutexattr_setrobust.3 page
 122
 123 pthread_mutexattr_setpshared.3
 124     Michael Kerrisk
 125         New link to new pthread_mutexattr_getpshared.3 page
 126
 127
 128 Global changes
 129 --------------
 130
 131 Various pages
 132     Michael Kerrisk
 133         Use .EX/.EE for EXAMPLE programs
 134
 135 Various pages
 136     Michael Kerrisk
 137         Use consistent markup for code snippets
 138             Change .nf/.fi to .EX/.EE
 139
 140 Various pages
 141     Michael Kerrisk
 142         Use consistent markup for code snippets
 143             The preferred form is
 144
 145                 .PP/.IP
 146                 .in +4n
 147                 .EX
 148                 <code>
 149                 .EE
 150                 .in
 151                 .PP/.IP
 152
 153 Various pages
 154     Michael Kerrisk
 155         Formatting fix: replace blank lines with .PP/.IP
 156             Blank lines shouldn't generally appear in *roff source (other
 157             than in code examples), since they create large vertical
 158             spaces between text blocks.
 159
 160 Various pages
 161     Michael Kerrisk  [Bjarni Ingi Gislason]
 162         Add a non-breaking space between a number and a unit (prefix)
 163             Based on a patch by Bjarni Ingi Gislason.
 164
 165 Various pages
 166     Michael Kerrisk  [Bjarni Ingi Gislason]
 167         Use en-dash for ranges
 168             Based on a patch by Bjarni Ingi Gislason.
 169
 170 A few pages
 171     Michael Kerrisk
 172         Fix misordering of sections
 173     Michael Kerrisk
 174         Fix order of SEE ALSO entries
 175
 176
 177 Changes to individual pages
 178 ---------------------------
 179
 180 ldd.1
 181     Michael Kerrisk
 182         Add more detail on ldd security implications, noting glibc 2.27 changes
 183
 184 add_key.2
 185 backtrace.3
 186 syslog.3
 187     Michael Kerrisk
 188         Fix misordered SEE ALSO entries
 189
 190 add_key.2
 191 request_key.2
 192 keyrings.7
 193     Eugene Syromyatnikov
 194         Update Linux documentation pointers
 195
 196 chown.2
 197     Michael Kerrisk
 198         Update kernel version in note on support for grpid/nogrpid mount options
 199             There has been no change since Linux 2.6.25, so update the
 200             kernel version to 4.12.
 201
 202 execve.2
 203     Michael Kerrisk
 204         SEE ALSO: add get_robust_list(2)
 205
 206 getrandom.2
 207     Michael Kerrisk  [Fabio Scotoni]
 208         SYNOPSIS: make return type of getrandom() 'ssize_t'
 209             This accords with glibc headers and the Linux kernel source.
 210
 211 getrlimit.2
 212     Thiago Jung Bauermann
 213         Mention unit used by RLIMIT_CORE and RLIMIT_FSIZE
 214     Michael Kerrisk
 215         Note that RLIMIT_AS and RLIMIT_DATA are rounded down to system page size
 216     Michael Kerrisk
 217         Mention unit for RLIMIT_DATA
 218
 219 getrlimit.2
 220 mmap.2
 221 malloc.3
 222     Jonas Grabber
 223         RLIMIT_DATA affects mmap (2) since Linux 4.7
 224
 225 get_robust_list.2
 226     Michael Kerrisk
 227         Detail the operation of robust futex lists
 228     Michael Kerrisk
 229         Since Linux 2.6.28, robust futex lists also have an effect for execve(2)
 230     Michael Kerrisk
 231         Clarify that "thread ID" means "kernel thread ID"
 232     Michael Kerrisk
 233         SEE ALSO: add pthread_mutexattr_setrobust(3)
 234
 235 ioctl_getfsmap.2
 236     Darrick J. Wong
 237         Correct semantics of FMR_OF_LAST flag
 238
 239 ioctl_userfaultfd.2
 240     Mike Rapoport
 241         Document replacement of ENOSPC with ESRCH
 242     Mike Rapoport
 243         Update uffdio_api.features description
 244             There is no requirement that uffdio_api.features must be zero
 245             for newer kernels. This field actually defines what features
 246             space would like to enable.
 247
 248 io_submit.2
 249     Sage Weil
 250         Acknowledge possibility of short return
 251             Note that the return value may be a value less than 'nr'
 252             if not all iocbs were queued at once.
 253
 254 ipc.2
 255     Michael Kerrisk
 256         SEE ALSO: add svipc(7)
 257
 258 keyctl.2
 259     Eugene Syromyatnikov
 260         mention keyctl_dh_compute(3) and keyctl_dh_compute_alloc (3)
 261             These functions have been added in keyutils 1.5.10
 262     Eugene Syromyatnikov
 263         Mention ENOMEM in ERRORS
 264     Eugene Syromyatnikov
 265         Update kernel documentation path reference
 266
 267 move_pages.2
 268     Otto Ebeling  [Michael Kerrisk]
 269         Note permission changes that occurred in Linux 4.13
 270
 271 mprotect.2
 272     Michael Kerrisk  [Shrikant Giridhar]
 273         Add warning about the use of printf() in the example code
 274
 275 open.2
 276     NeilBrown
 277         Improve O_PATH documentation
 278             - fstatfs is now permitted.
 279             - ioctl isn't, and is worth listing explicitly
 280             - O_PATH allows an automount point to be opened with
 281               triggering the mount.
 282
 283 prctl.2
 284 seccomp.2
 285     Eugene Syromyatnikov
 286         Update pointer to in-kernel seccomp documentation
 287
 288 prctl.2
 289 ptrace.2
 290     Eugene Syromyatnikov
 291         Update pointer to in-kernel Yama documentation
 292
 293 prctl.2
 294     Eugene Syromyatnikov
 295         Update pointer to in-kernel no_new_privs flag documentation
 296
 297 readlink.2
 298     Michael Kerrisk  [Jason Noakes]
 299         Fix an off-by-one error in example code
 300
 301 seccomp.2
 302     Kees Cook
 303         Clarify SECCOMP_RET_KILL kills tasks not processes
 304
 305 select_tut.2
 306     Michael Kerrisk  [Sergey Z.]
 307         Clarify an ambiguity with respect to select() and EAGAIN
 308             See https://bugzilla.kernel.org/show_bug.cgi?id=196345
 309
 310 set_tid_address.2
 311     Elliott Hughes
 312         Note that there's no glibc wrapper for set_tid_address()
 313
 314 socket.2
 315     Michael Kerrisk  [Yubin Ruan]
 316         socket() uses the lowest available file descriptor
 317
 318 _syscall.2
 319     Michael Kerrisk
 320         Remove redundant comment from EXAMPLE
 321             A discussion of the nroff source of the manual
 322             page isn't very useful...
 323
 324 sysfs.2
 325     Michael Kerrisk
 326         Add a pointer to sysfs(5) to help possibly confused readers
 327     Michael Kerrisk
 328         Make it clearer near the start of the page that sysfs(2) is obsolete
 329
 330 timer_create.2
 331     Michael Kerrisk
 332         Strengthen the warning about use of printf() in the example program
 333     Michael Kerrisk
 334         Update cross reference: signal(7) should be signal-safety(7)
 335
 336 umount.2
 337     NeilBrown
 338         Revise MNT_FORCE description
 339             MNT_FORCE does not allow a busy filesystem to be unmounted.  Only
 340             MNT_DETACH allows that.  MNT_FORCE only tries to abort pending
 341             transactions, in the hope that might help umount not to block,
 342
 343             Also, other filesystems than NFS support MNT_FORCE.
 344
 345 unshare.2
 346     Eugene Syromyatnikov
 347         Update pointer to in-kernel unshare documentation
 348
 349 wait.2
 350     Michael Kerrisk  [Ильдар Низамов]
 351         POSIX.1-2008 TC1 clarifies treatment of 'si_pid' for waitid() WNOHANG
 352
 353 cmsg.3
 354     Sukadev Bhattiprolu
 355         Add a scatter/gather buffer to sample code
 356     Michael Kerrisk
 357         Reorganize the text somewhat (no content changes)
 358
 359 crypt.3
 360     Konstantin Shemyak  [Michael Kerrisk]
 361         Add description of previously undocumented 'rounds' parameter
 362     Konstantin Shemyak
 363         Encryption isn't done with SHA-xxx, but with a function based on SHA-xxx
 364     Konstantin Shemyak
 365         Clarify that ending of the salt string with '$' is optional
 366
 367 exit.3
 368     Michael Kerrisk
 369         Mention the prctl(2) PR_SET_PDEATHSIG operation
 370     Michael Kerrisk
 371         SEE ALSO: add get_robust_list(2)
 372     Michael Kerrisk
 373         Add a heading to delimit discussion of signals sent to other processes
 374
 375 exp2.3
 376     Alex Henrie
 377         Remove C89 designation
 378
 379 log1p.3
 380     Alex Henrie
 381         Document fixes to give EDOM or ERANGE on error
 382
 383 matherr.3
 384     Michael Kerrisk
 385         Note that glibc 2.27 removes the 'matherr' mechanism
 386     Michael Kerrisk
 387         Remove crufty feature test macro requirements
 388
 389 pow10.3
 390     Michael Kerrisk
 391         Note that pow10() is now obsolete in favor of exp10()
 392             Also, the pow10() functions are no longer supported by glibc,
 393             starting with version 2.27.
 394
 395 sincos.3
 396     Michael Kerrisk
 397         Note that sincos() is intended to be more efficient than sin() + cos()
 398
 399 cciss.4
 400 hpsa.4
 401     Eugene Syromyatnikov  [Don Brace, Meelis Roos]
 402         Mention cciss removal in Linux 4.14
 403             During the Linux 4.13 development cycle, the cciss driver has been
 404             removed in favor of the hpsa driver, which has been amended with
 405             some legacy board support.
 406
 407 initrd.4
 408 proc.5
 409 bootparam.7
 410     Eugene Syromyatnikov
 411         Update pointer to in-kernel initrd documentation
 412
 413 initrd.4
 414     Eugene Syromyatnikov
 415         Update pointer to in-kernel root over NFS documentation
 416
 417 intro.4
 418     Michael Kerrisk
 419         SEE ALSO: add mknod(1) and mknod(2)
 420
 421 host.conf.5
 422     Michael Kerrisk
 423         Add cross-reference to hosts(5)
 424
 425 locale.5
 426     Marko Myllynen
 427         Refer to existing locales for encoding details
 428             Since I don't think it would make sense to try to have different
 429             explanation for each glibc version on the locale(5) man page, I'm
 430             proposing that we apply the below patch so that we refer to
 431             existing locale definition files in general and not spell out the
 432             exact format or any certain locale as a definitive guideline.
 433
 434 nologin.5
 435     Michael Kerrisk
 436         Add a sentence explaining why nologin is useful
 437
 438 proc.5
 439     Eugene Syromyatnikov
 440         Document removal of htab-reclaim sysctl file
 441             This PPC-specific sysctl option has been removed in Linux 2.4.9.2,
 442             according to historic Linux repository commit log.
 443     Eugene Syromyatnikov
 444         Add description for cpuN lines in /proc/stat
 445     Eugene Syromyatnikov
 446         Add description for softirq line in /proc/stat
 447     Eugene Syromyatnikov
 448         Document removal of timer_stats file
 449     Michael Kerrisk
 450         Note Linux 4.9 changes to privileges for /proc/[pid]/timerslack_ns
 451     Michael Kerrisk
 452         Show command used to mount /proc
 453     Michael Kerrisk
 454         Explicitly note in intro that some /proc files are writable
 455     Eugene Syromyatnikov
 456         Update pointer to in-kernel SysRq documentation
 457     Michael Kerrisk
 458         SEE ALSO: add sysfs(5)
 459     Eugene Syromyatnikov
 460         Update pointer to in-kernel security keys documentation
 461     Benjamin Peterson
 462         Fix path to binfmt_misc docs
 463     Eugene Syromyatnikov
 464         Update pointer to in-kernel MTRR documentation
 465     Eugene Syromyatnikov
 466         Update reference to kernel's crypto API documentation
 467
 468 tzfile.5
 469     Paul Eggert
 470         Sync from tzdb upstream
 471             This makes tzfile.5 a copy of the tzdb version, except that the
 472             tzdb version's first line is replaced by man-pages boilerplate.
 473             The new version documents version 3 format, among other things.
 474             Also, it removes the "Summary of the timezone information file
 475             format" section, which should no longer be needed due to
 476             improvements in the the part of the man page.
 477
 478 capabilities.7
 479     Michael Kerrisk
 480         Note semantics for a program that is set-UID-root and has capabilities
 481             Note semantics for a program that is both set-user-ID-root and has
 482             file capabilities.
 483     Michael Kerrisk  [Dennis Knorr]
 484         Note that a set-UID-root program may have an empty file capabilite set
 485
 486 cgroups.7
 487     Michael Kerrisk
 488         SEE ALSO: systemd-cgls(1)
 489
 490 cpuset.7
 491     Eugene Syromyatnikov
 492         Update pointer to in-kernel cpusets documentation
 493
 494 keyrings.7
 495     Eugene Syromyatnikov
 496         Document description restriction for logon keys
 497             "logon" type has additional check that enforces colon-separated
 498             prefix in key descriptions.
 499     Eugene Syromyatnikov
 500         Add pointers to kernel's documentation
 501             Mostly because of assymmetric-keys.txt, which is outside
 502             security/keys for some reason.
 503
 504 man-pages.7
 505     Michael Kerrisk
 506         Expand the guidance on formatting code snippets
 507
 508 netlink.7
 509     David Wilder
 510         Change buffer size in example code about reading netlink message
 511     Michael Kerrisk  [Rick Jones]
 512         Add a comment on 8192 buffer size in example code
 513
 514 pthreads.7
 515     Michael Kerrisk
 516         SEE ALSO: add pthread_mutexattr_destroy(3) and pthread_mutexattr_init(3)
 517
 518 signal.7
 519     Michael Kerrisk
 520         Since glibc 2.26, SIGUNUSED is no longer defined
 521
 522 tcp.7
 523     Vincent Bernat
 524         tcp_tw_recycle is removed from Linux 4.12
 525             And it is completely broken.
 526
 527 unicode.7
 528     Eugene Syromyatnikov
 529         Update pointer to in-kernel Unicode terminal support documentation