Changes

   1 ==================== Changes in man-pages-5.12 ====================
   2
   3 Released: ????-??-??, Christchurch
   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 Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
  14 Akihiro Motoki <amotoki@gmail.com>
  15 Alejandro Colomar <alx.manpages@gmail.com>
  16 Alyssa Ross <hi@alyssa.is>
  17 Aurelien Aptel <aaptel@suse.com>
  18 Borislav Petkov <bp@suse.de>
  19 Bruce Merry <bmerry@ska.ac.za>
  20 Chris Keilbart <keilbartchris@gmail.com>
  21 Christian Brauner <christian@brauner.io>
  22 Christoph Anton Mitterer <calestyo@scientia.net>
  23 dann frazier <dann.frazier@canonical.com>
  24 Dmitry V. Levin <ldv@altlinux.org>
  25 Florian Weimer <fw@deneb.enyo.de>
  26 Huang Ying <ying.huang@intel.com>
  27 Jakub Wilk <jwilk@jwilk.net>
  28 James O. D. Hunt <jamesodhunt@gmail.com>
  29 Jann Horn <jannh@google.com>
  30 Johannes Berg <johannes@sipsolutions.net>
  31 Jon Murphy <jonmurphy1618@gmail.com>
  32 Josh Triplett <josh@joshtriplett.org>
  33 Katsuhiro Numata <byakkomon@gmail.com>
  34 Kees Cook <keescook@chromium.org>
  35 Mark Kettenis <kettenis@openbsd.org>
  36 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  37 Michael Kerrisk <mtk.manpages@gmail.com>
  38 Mike Rapoport <rppt@linux.vnet.ibm.com>
  39 Peter Xu <peterx@redhat.com>
  40 Sargun Dhillon <sargun@sargun.me>
  41 Stefan Puiu <stefan.puiu@gmail.com>
  42 Štěpán Němec <stepnem@gmail.com>
  43 thomasavoss <thomasavoss@protonmail.com>
  44 Topi Miettinen <toiwoton@gmail.com>
  45 Tycho Andersen <tycho@tycho.pizza>
  46 Utkarsh Singh <utkarsh190601@gmail.com>
  47 Vishwajith K <vishuvikas1996@gmail.com>
  48 Walter Harms <wharms@bfs.de>
  49 Yang Xu <xuyang2018.jy@fujitsu.com>
  50 Zhiheng Li <phoenix_lzh@sina.com>
  51 наб <nabijaczleweli@nabijaczleweli.xyz>
  52
  53 Apologies if I missed anyone!
  54
  55
  56 New and rewritten pages
  57 -----------------------
  58
  59 seccomp_unotify.2
  60     Michael Kerrisk  [Tycho Andersen, Jann Horn, Kees Cook, Christian Brauner
  61                       Sargun Dhillon]
  62         New page documenting the seccomp user-space notification mechanism
  63
  64 MAX.3
  65     Alejandro Colomar
  66         New page to document MAX() and MIN()
  67
  68
  69 Newly documented interfaces in existing pages
  70 ---------------------------------------------
  71
  72 seccomp.2
  73     Tycho Andersen  [MichaelKerrisk]
  74         Document SECCOMP_GET_NOTIF_SIZES
  75     Tycho Andersen
  76         Document SECCOMP_FILTER_FLAG_NEW_LISTENER   [Michael Kerrisk]
  77     Tycho Andersen
  78         Document SECCOMP_RET_USER_NOTIF  [Michael Kerrisk]
  79
  80 set_mempolicy.2
  81     Huang Ying  [Alejandro Colomar, "Huang, Ying"]
  82         Add mode flag MPOL_F_NUMA_BALANCING
  83
  84 userfaultfd.2
  85     Peter Xu  [Alejandro Colomar, Mike Rapoport]
  86         Add UFFD_FEATURE_THREAD_ID docs
  87     Peter Xu  [Alejandro Colomar, Mike Rapoport]
  88         Add write-protect mode docs
  89
  90 proc.5
  91     Michael Kerrisk
  92         Document /proc/sys/vm/sysctl_hugetlb_shm_group
  93
  94 system_data_types.7
  95     Alejandro Colomar
  96         Add 'blksize_t'
  97     Alejandro Colomar
  98         Add 'blkcnt_t'
  99     Alejandro Colomar
 100         Add 'mode_t'
 101     Alejandro Colomar
 102         Add 'struct sockaddr'
 103     Alejandro Colomar
 104         Add 'cc_t'
 105     Alejandro Colomar
 106         Add 'socklen_t'
 107
 108
 109 New and changed links
 110 ---------------------
 111
 112 blkcnt_t.3
 113     Alejandro Colomar
 114         New link to system_data_types(7)
 115
 116 blksize_t.3
 117     Alejandro Colomar
 118         New link to system_data_types(7)
 119
 120 cc_t.3
 121     Alejandro Colomar
 122         New link to system_data_types(7)
 123
 124 MIN.3
 125     Michael Kerrisk
 126         New link to MIN.3
 127
 128 mode_t.3
 129     Alejandro Colomar
 130         New link to system_data_types(7)
 131
 132 sockaddr.3
 133     Alejandro Colomar
 134         New link to system_data_types(7)
 135
 136 socklen_t.3
 137     Alejandro Colomar
 138         New link to system_data_types(7)
 139
 140
 141 Global changes
 142 --------------
 143
 144 Many pages
 145     Alejandro Colomar
 146         SYNOPSIS: Use syscall(SYS_...); for system calls without a wrapper
 147
 148 Many pages
 149     Alejandro Colomar
 150         SYNOPSIS: Document why each header is required
 151
 152 Many pages
 153     Alejandro Colomar
 154         SYNOPSIS: Remove unused includes
 155
 156 Various pages
 157     Alejandro Colomar
 158         Add note about the use of syscall(2)
 159
 160 Various pages
 161     Alejandro Colomar
 162         SYNOPSIS: Miscellaneous fixes to includes
 163
 164 A few pages
 165     Alejandro Colomar
 166         SYNOPSIS: Add missing 'const'
 167
 168
 169 Changes to individual pages
 170 ---------------------------
 171
 172 dup.2
 173     Michael Kerrisk
 174         Rewrite the description of dup() somewhat
 175             As can be seen by any number of StackOverflow questions, people
 176             persistently misunderstand what dup() does, and the existing manual
 177             page text, which talks of "copying" a file descriptor doesn't help.
 178             Rewrite the text a little to try to prevent some of these
 179             misunderstandings, in particular noting at the start that dup()
 180             allocates a new file descriptor.
 181     Michael Kerrisk
 182         Clarify what silent closing means
 183     Alejandro Colomar
 184         SYNOPSIS: Use consistent comments through pages
 185
 186 epoll_wait.2
 187     Alejandro Colomar
 188         Move misplaced subsection to NOTES from BUGS
 189
 190 execveat.2
 191     Michael Kerrisk
 192         Library support has been added in glibc 2.34
 193
 194 _exit.2
 195     Michael Kerrisk
 196         Add a little more detail on the raw _exit() system cal
 197
 198 exit_group.2
 199     Alejandro Colomar
 200         Use 'noreturn' in prototypes
 201
 202 flock.2
 203     Aurelien Aptel  [Alejandro Colomar]
 204         Add CIFS details
 205             CIFS flock() locks behave differently than the standard.
 206             Give an overview of those differences.
 207
 208 ioperm.2
 209     Alejandro Colomar
 210         Remove obvious comment
 211
 212 memfd_create.2
 213 mmap.2
 214 shmget.2
 215     Michael Kerrisk  [Yang Xu]
 216         Document the EPERM error for huge page allocations
 217             This error can occur if the caller is does not have CAP_IPC_LOCK
 218             and is not a member of the sysctl_hugetlb_shm_group.
 219
 220 mmap.2
 221     Bruce Merry
 222         Clarify that MAP_POPULATE is best-effort
 223
 224 mount.2
 225     Topi Miettinen
 226         Document SELinux use of MS_NOSUID mount flag
 227
 228 open.2
 229     Alejandro Colomar  [Walter Harms]
 230         Fix bug in linkat(2) call example
 231             AT_EMPTY_PATH works with empty strings (""), but not with NULL
 232             (or at least it's not obvious).
 233     Michael Kerrisk
 234         Make it clearer that an FD is an index into the process's FD table
 235             Sometimes people are confused, thinking a file descriptor is just a
 236             number....
 237
 238 perfmonctl.2
 239     Michael Kerrisk
 240         This system call was removed in Linux 5.10
 241
 242 pipe.2
 243     Alejandro Colomar
 244         SYNOPSIS: Fix incorrect prototype
 245     Michael Kerrisk
 246         Rearrange SYNOPSIS so that minority version pipe() is at end
 247
 248 ptrace.2
 249     Dmitry V. Levin  [Alejandro Colomar, Mathieu Desnoyers]
 250         Mention PTRACE_GET_SYSCALL_INFO in RETURN VALUE section
 251
 252 seccomp.2
 253     Michael Kerrisk
 254         Reorder list of SECCOMP_SET_MODE_FILTER flags alphabetically
 255             (No content changes.)
 256     Michael Kerrisk
 257         SEE ALSO: add seccomp_unotify(2)
 258
 259 select.2
 260     Michael Kerrisk
 261         Strengthen the warning regarding the low value of FD_SETSIZE
 262             All modern code should avoid select(2) in favor of poll(2)
 263             or epoll(7).
 264     Michael Kerrisk
 265         Relocate sentence about the fd_set value-result arguments to BUGS
 266
 267 syscalls.2
 268     Michael Kerrisk
 269         perfmonctl(2) was removed in Linux 5.10
 270
 271 bswap.3
 272     Alejandro Colomar
 273         bswap_*() are implemented using functions
 274             Even though it's true that they are macros,
 275             it's transparent to the user.
 276
 277             The user will see their results casted to unsigned types
 278             after the conversion due to the underlying functions,
 279             so it's better to document these as the underlying functions,
 280             specifying the types.
 281
 282 cmsg.3
 283 unix.7
 284     Michael Kerrisk
 285         Refer to seccomp_unotify(2) for an example of SCM_RIGHTS usage
 286
 287 cpow.3
 288     Alejandro Colomar
 289         Use 'complex' after the type consistently
 290
 291 ctime.3
 292     Michael Kerrisk  [Katsuhiro Numata]
 293         Restore documentation of 'tm_gmtoff' field
 294
 295 errno.3
 296     Alejandro Colomar  [Florian Weimer, Mark Kettenis]
 297         Fix ENODATA text
 298             ENODATA is an XSI STREAMS extension (not base POSIX).
 299
 300 exec.3
 301     Josh Triplett  [Alejandro Colomar]
 302         Clarify that execvpe() uses PATH from the caller, not envp
 303     Josh Triplett  [Alejandro Colomar]
 304         Fix description of 'e' variants
 305             The envp argument specifies the environment of the new process
 306             image, not "the environment of the caller".
 307
 308 fflush.3
 309     Alejandro Colomar
 310         SEE ALSO: Add fpurge(3)
 311
 312 getline.3
 313     наб  [Ahelenia Ziemiańska, Alejandro Colomar]
 314         !*lineptr is sufficient
 315             No implementation or spec requires *n to be 0 to allocate
 316             a new buffer.
 317
 318 getopt.3
 319     James O. D. Hunt  [Alejandro Colomar]
 320         Clarify behaviour
 321
 322 printf.3
 323     Utkarsh Singh  [Alejandro Colomar]
 324         Add overall structure of format string
 325
 326 pthread_attr_setinheritsched.3
 327 pthread_attr_setschedparam.3
 328     Alejandro Colomar
 329         SYNOPSIS: Use 'restrict' in prototypes
 330
 331 pthread_mutexattr_setrobust.3
 332     Michael Kerrisk
 333         Note that the *_np() APIs are deprecated since glibc 2.34
 334     Alejandro Colomar
 335         SYNOPSIS: Remove incorrect 'const'
 336
 337 pthread_mutex_consistent.3
 338     Michael Kerrisk
 339         Note that pthread_mutexattr_setrobust() is now deprecated
 340
 341 pthread_yield.3
 342     Michael Kerrisk
 343         Note that this function is deprecated since glibc 2.34
 344
 345 rpc.3
 346     Alejandro Colomar
 347         SYNOPSIS: Fix prototypes (misc.)
 348
 349 scanf.3
 350     Alyssa Ross  [Alejandro Colomar]
 351         Clarify that %n supports type modifiers
 352
 353 xdr.3
 354     Alejandro Colomar
 355         SYNOPSIS: Fix prototype types
 356             Use the same types glibc uses, and add a missing 'const'.
 357
 358 capabilities.7
 359     Michael Kerrisk
 360         CAP_IPC_LOCK also governs memory allocation using huge pages
 361
 362 environ.7
 363     Josh Triplett  [Alejandro Colomar]
 364         Remove obsolete admonishment of the GZIP environment variable
 365
 366 kernel_lockdown.7
 367     dann frazier  [Alejandro Colomar]
 368         Remove description of lifting via SysRq (not upstream)
 369             The patch that implemented lockdown lifting via SysRq ended up
 370             getting dropped[*] before the feature was merged upstream. Having
 371             the feature documented but unsupported has caused some confusion
 372             for our users.
 373
 374 mount_namespaces.7
 375 namespaces.7
 376     Michael Kerrisk
 377         Relocate reference to pam_namespace(8) from namespaces.7 to
 378         mount_namespaces.7.
 379
 380 signal.7
 381     Michael Kerrisk
 382         Add reference to seccomp_unotify(2)
 383             The seccomp user-space notification feature can cause changes in
 384             the semantics of SA_RESTART with respect to system calls that
 385             would never normally be restarted. Point the reader to the page
 386             that provide further details.
 387
 388 vsock.7
 389     Alyssa Ross
 390         ioctls are on /dev/vsock, not sockets