original/Changes

   1 ==================== Changes in man-pages-3.52 ====================
   2
   3 Released: 2013-07-04, 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 Adrian Bunk <bunk@kernel.org>
  14 Andrea Remondini <andrea@undeadlinks.com>
  15 Anthony Foiani <anthony.foiani@gmail.com>
  16 Brian Norris <computersforpeace@gmail.com>
  17 Cyril Hrubis <chrubis@suse.cz>
  18 Dan Jacobson <jidanni@jidanni.org>
  19 David Prévot <taffit@debian.org>
  20 Eric S. Raymond <esr@thyrsus.com>
  21 Georg Sauthoff <mail@georg.so>
  22 Jeff Moyer <jmoyer@redhat.com>
  23 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  24 Jon Grant <jg@jguk.org>
  25 Manuel Traut <manut@linutronix.de>
  26 Марк Коренберг <socketpair@gmail.com>
  27 Michael Kerrisk <mtk.manpages@gmail.com>
  28 Mike Frysinger <vapier@gentoo.org>
  29 Pavel Emelyanov <xemul@parallels.com>
  30 Peng Haitao <penght@cn.fujitsu.com>
  31 Peter LaDow <petela@gocougs.wsu.edu>
  32 Petr Gajdos <pgajdos@suse.cz>
  33 Regid <regid23@nt1.in>
  34 Siddhesh Poyarekar <siddhesh@redhat.com>
  35 Simone Piccardi <piccardi@truelite.it>
  36 Simon Paillard <spaillard@debian.org>
  37 Vince Weaver <vincent.weaver@maine.edu>
  38 Yuri Kozlov <yuray@komyakino.ru>
  39
  40 Apologies if I missed anyone!
  41
  42
  43 Newly documented interfaces in existing pages
  44 ---------------------------------------------
  45
  46 perf_event_open.2
  47     Vince Weaver
  48         Add PERF_IOC_FLAG_GROUP documentation
  49             The perf_event_open() ENABLE/DISABLE/RESET ioctls can take an
  50             argument, PERF_IOC_FLAG_GROUP.  This wasn't documented at all
  51             until about a year ago (despite the support being there from
  52             the beginning) so I missed this when initially writing
  53             the man page.
  54
  55 socket.7
  56     Pavel Emelyanov, Michael Kerrisk
  57         Document SO_PEEK_OFF option
  58             Since Linux 3.4 there appeared an ability to specify the
  59             offset in bytes from which the data will be MSG_PEEK-ed.
  60             Describe this socket option in the socket(7) page, where
  61             all the other socket options are described.
  62
  63
  64 Global changes
  65 --------------
  66
  67 Various pages
  68     Michael Kerrisk
  69         Convert inline formatting (\fX...\fP) to dot-directive formatting
  70
  71 readdir.2
  72 asprintf.
  73 getline.3
  74 getlogin.3
  75 pthread_setname_np.3
  76 readdir.3
  77 strerror.3
  78     Michael Kerrisk  [Jon Grant]
  79         Clarify that terminating null byte is '\0'
  80
  81
  82 Changes to individual pages
  83 ---------------------------
  84
  85 execve.2
  86     Peter LaDow
  87        Add envp to the Linux notes about NULL pointers
  88             During the review of static analysis results, we discovered a
  89             functional, but non-portable, use of execve().  For example:
  90
  91                 char *cmd[] = { "/path/to/some/file", NULL };
  92                 execve(cmd[0], cmd, NULL);
  93
  94             The call succeeds.  Yet, the static analysis tool (rightly)
  95             pointed out that envp could be dereferenced.  But digging into
  96             glibc and the kernel, it appears that like argv, envp when NULL
  97             is treated as if it were an empty list.
  98
  99             So, to clear things up, I'm submitting this patch to update the
 100             man page to indicate that envp is treated like argv.
 101
 102 fallocate.2
 103     Michael Kerrisk
 104         RETURN VALUE: mention that 'errno' is set on error
 105
 106 io_setup.2
 107     Cyril Hrubis  [Jeff Moyer]
 108         Clarify the nr_events parameter
 109             Currently the io_setup.2 man page describes what the kernel really
 110             does, i.e., that the resulting context may be able to hold more
 111             than the 'nr_event's operations because the memory allocated in
 112             kernel is rounded to be multiple of page size.
 113
 114             It is better not to expose this implementation detail and
 115             simply state that the resulting context is suitable for
 116             'nr_events' operations.
 117
 118 perf_event_open.2
 119     Vince Weaver
 120         Clarify the perf_event_open() wakeup_events/wakeup_watermark fields
 121             Clarify the perf_event_open() wakeup_events/wakeup_watermark
 122             fields a bit, based on info from kernel commit cfeb1d90a1b1.
 123     Vince Weaver
 124         Update to match the Linux 3.10 release
 125             This patch updates the perf_event_open() documentation to include
 126             new interfaces added in the 3.10 kernel.
 127
 128             It also documents a few [To be documented] instances left over
 129             from the 3.7 kernel.
 130     Vince Weaver
 131         Small correction to description of 'flags' argument
 132
 133 prctl.2
 134     Michael Kerrisk
 135         Note equivalents of PR_SET_NAME
 136             pthread_setname_np() and pthread_getname_np() and
 137             /proc/self/task/TID/comm provide access to the same
 138             attribute.
 139
 140 pread.2
 141     Michael Kerrisk  [Марк Коренберг]
 142         pread() and pwrite() are especially useful in multithreaded applications
 143
 144 recv.2
 145     Michael Kerrisk
 146         RETURN VALUE: mention that 'errno' is set on error
 147
 148 semctl.2
 149     Michael Kerrisk  [Simone Piccardi]
 150         'sem_nsems' is 'unsigned long' since Linux 2.4
 151
 152 shmget.2
 153     Michael Kerrisk
 154         Rewrite RETURN VALUE and mention that 'errno' is set on error
 155
 156 sigaction.2
 157     Michael Kerrisk  [Brian Norris]
 158         RETURN VALUE: mention that 'errno' is set on error
 159
 160 signal.2
 161     Michael Kerrisk
 162         RETURN VALUE: mention that 'errno' is set on error
 163
 164 sigpending.2
 165     Michael Kerrisk
 166         RETURN VALUE: mention that 'errno' is set on error
 167
 168 sigprocmask.2
 169     Michael Kerrisk
 170         RETURN VALUE: mention that 'errno' is set on error
 171
 172 sigsuspend.2
 173     Michael Kerrisk
 174         RETURN VALUE: mention that 'errno' is set on error
 175
 176 syscall.2
 177     Mike Frysinger
 178         Document s390/s390x calling convention
 179
 180 a64l.3
 181     Peng Haitao
 182         ATTRIBUTES: Note function that is not thread-safe
 183             The function l64a() is not thread safe.
 184
 185 abs.3
 186     Peng Haitao
 187         ATTRIBUTES: Note functions that are thread-safe
 188             The functions abs(), labs(), llabs() and imaxabs() are
 189             thread-safe.
 190
 191 aio_error.3
 192     Peng Haitao
 193         ATTRIBUTES: Note function that is thread-safe
 194             The function aio_error() is thread safe.
 195
 196 aio_return.3
 197     Peng Haitao
 198         ATTRIBUTES: Note function that is thread-safe
 199             The function aio_return() is thread safe.
 200
 201 alloca.3
 202     Adrian Bunk
 203         Correct information on getting non-inlined version with gcc+glibc
 204             - remove the incorrect information that -fno-builtin would help
 205             - add -std=c11 to the list of strict options
 206             - emphasize more that both the gcc option and not including
 207               alloca.h are needed
 208             - add the #ifdef from the glibc alloca.h to make the situation
 209               clearer
 210
 211 bindresvport.3
 212     Peng Haitao
 213         ATTRIBUTES: Note function that is thread-safe
 214             Before glibc 2.17, bindresvport() is not thread-safe.
 215             Since glibc 2.17, it is thread-safe, the patch can refer to URL:
 216             http://sourceware.org/git/?p=glibc.git;a=commit;h=f6da27e53695ad1cc0e2a9490358decbbfdff5e5
 217
 218 canonicalize_file_name.3
 219     Michael Kerrisk
 220         Put CONFORMING TO section in right location
 221
 222 catgets.3
 223     Michael Kerrisk  [Jon Grant]
 224         Clarify that null byte is '\0'
 225
 226 ceil.3
 227     Peng Haitao
 228         ATTRIBUTES: Note functions that are thread-safe
 229             The functions ceil(), ceilf() and ceill() are thread safe.
 230
 231 cimag.3
 232     Peng Haitao
 233         ATTRIBUTES: Note functions that are thread-safe
 234             The functions cimag(), cimagf() and cimagl() are thread safe.
 235
 236 clock_getcpuclockid.3
 237     Peng Haitao
 238         ATTRIBUTES: Note function that is thread-safe
 239             The function clock_getcpuclockid() is thread safe.
 240
 241 conj.3
 242     Peng Haitao
 243         ATTRIBUTES: Note functions that are thread-safe
 244             The functions conj(), conjf() and conjl() are thread safe.
 245
 246 crypt.3
 247     Peng Haitao
 248         ATTRIBUTES: Note function that is not thread-safe
 249             The function crypt() is not thread safe.
 250
 251 ctermid.3
 252     Peng Haitao
 253         ATTRIBUTES: Note function that is thread safe with exceptions
 254             The function ctermid() is thread safe with exceptions.
 255
 256 dirfd.3
 257     Michael Kerrisk
 258         RETURN VALUE: mention that 'errno' is set on error
 259
 260 drand48.3
 261     Peng Haitao
 262         ATTRIBUTES: Note functions that are not thread-safe
 263             The functions drand48(), erand48(), lrand48(), nrand48(),
 264             mrand48(), jrand48(), srand48(), seed48() and lcong48() are
 265             not thread safe.
 266
 267 ecvt.3
 268     Peng Haitao
 269         ATTRIBUTES: Note functions that are not thread-safe
 270             The functions ecvt() and fcvt() return a string located in a
 271             static buffer which is overwritten by the next call to the
 272             functions, so they are not thread-safe.
 273
 274 encrypt.3
 275     Peng Haitao
 276         ATTRIBUTES: Note functions that are not thread-safe
 277             The functions encrypt() and setkey() are not thread safe.
 278
 279 ether_aton.3
 280     Peng Haitao
 281         ATTRIBUTES: Note functions that are not thread-safe
 282             The functions ether_aton() and ether_ntoa() are not thread safe.
 283
 284 fcloseall.3
 285     Peng Haitao
 286         ATTRIBUTES: Note function that is not thread-safe
 287             The function fcloseall() is not thread safe.
 288
 289 ferror.3
 290     Peng Haitao
 291         ATTRIBUTES: Note functions that are thread-safe
 292             The functions ferror(), clearerr(), feof() and fileno() are
 293             thread safe.
 294
 295 fgetgrent.3
 296     Michael Kerrisk
 297         RETURN VALUE: mention that 'errno' is set on error
 298
 299 fgetpwent.3
 300     Michael Kerrisk
 301         RETURN VALUE: mention that 'errno' is set on error
 302
 303 fgetwc.3
 304     Michael Kerrisk
 305         RETURN VALUE: mention that 'errno' is set on error
 306
 307 fmtmsg.3
 308     Peng Haitao
 309         ATTRIBUTES: Note function that is thread-safe
 310             Before glibc 2.16, fmtmsg() is not thread-safe.
 311             Since glibc 2.16, it is thread-safe, the patch can refer to URL:
 312             http://sourceware.org/git/?p=glibc.git;a=commit;h=7724defcf8873116fe4efab256596861eef21a94
 313
 314 fputwc.3
 315     Michael Kerrisk
 316         RETURN VALUE: mention that 'errno' is set on error
 317
 318 getdate.3
 319     Peng Haitao
 320         ATTRIBUTES: Note functions that are and aren't thread-safe
 321
 322 getgrent.3
 323     Peng Haitao
 324         ATTRIBUTES: Note function that is not thread-safe
 325             The function getgrent() is not thread safe.
 326
 327 getgrnam.3
 328     Peng Haitao
 329         ATTRIBUTES: Note functions that are and aren't thread-safe
 330
 331 getline.3
 332     Michael Kerrisk
 333         RETURN VALUE: mention that 'errno' is set on error
 334
 335 getlogin.3
 336     Peng Haitao
 337         ATTRIBUTES: Note function that is not thread-safe
 338             The function getlogin() is not thread safe.
 339             The function cuserid() is thread-safe with exceptions.
 340     Michael Kerrisk
 341         RETURN VALUE: mention that 'errno' is set on error
 342
 343 getpass.3
 344     Peng Haitao
 345         ATTRIBUTES: Note functions that are not thread-safe
 346
 347 getpwent.3
 348     Peng Haitao
 349         ATTRIBUTES: Note function that is not thread-safe
 350             The function getpwent() is not thread safe.
 351
 352 getpwnam.3
 353     Peng Haitao
 354         ATTRIBUTES: Note functions that are and aren't thread-safe
 355
 356 getspnam.3
 357     Michael Kerrisk
 358         RETURN VALUE: mention that 'errno' is set on error
 359
 360 getttyent.3
 361     Peng Haitao
 362         ATTRIBUTES: Note functions that are not thread-safe
 363
 364 getusershell.3
 365     Peng Haitao
 366         ATTRIBUTES: Note functions that are not thread-safe
 367             The functions getusershell(), setusershell() and endusershell()
 368             are not thread safe.
 369
 370 getutent.3
 371     Michael Kerrisk
 372         RETURN VALUE: mention that 'errno' is set on error
 373
 374 hsearch.3
 375     Michael Kerrisk
 376         RETURN VALUE: mention that 'errno' is set on error
 377
 378 hsearch.3
 379     Peng Haitao
 380         ATTRIBUTES: Note functions that are not thread-safe
 381             The functions hsearch(), hcreate() and hdestroy() are not
 382             thread-safe.
 383
 384 localeconv.3
 385     Peng Haitao
 386         ATTRIBUTES: Note functions that are not thread-safe
 387             The function localeconv() returns a pointer to a structure which
 388             might be overwritten by subsequent calls to localeconv() or by
 389             calls to setlocale(), so it is not thread-safe.
 390     Peng Haitao
 391         Add RETURN VALUE section
 392
 393 malloc_info.3
 394     Michael Kerrisk
 395         RETURN VALUE: mention that 'errno' is set on error
 396
 397 mblen.3
 398     Peng Haitao
 399         ATTRIBUTES: Note function that is not thread-safe
 400             The function mblen() is not thread safe.
 401
 402 mbrlen.3
 403     Peng Haitao
 404         ATTRIBUTES: Note function that is thread safe with exceptions
 405             The function mbrlen() is thread safe with exceptions.
 406
 407 mbrtowc.3
 408     Peng Haitao
 409         ATTRIBUTES: Note function that is thread safe with exceptions
 410             The function mbrtowc() is thread safe with exceptions.
 411
 412 mktemp.3
 413     Michael Kerrisk
 414         RETURN VALUE: mention that 'errno' is set on error
 415
 416 modf.3
 417     Peng Haitao
 418         ATTRIBUTES: Note functions that are thread-safe
 419             The functions modf(), modff() and modfl() are thread safe.
 420
 421 popen.3
 422     Michael Kerrisk
 423         RETURN VALUE: mention that 'errno' is set on error
 424
 425 pthread_attr_setinheritsched.3
 426     Michael Kerrisk
 427         Note the scheduling attributes affected by this function
 428
 429 pthread_attr_setschedparam.3
 430 pthread_attr_setschedpolicy.3
 431 pthread_attr_setscope.3
 432     Michael Kerrisk  [Manuel Traut, Siddhesh Poyarekar]
 433         The inherit-scheduler attribute must be set to PTHREAD_EXPLICIT_SCHED
 434             In order for the attributes set by these functions to have
 435             an effect, the caller must use pthread_attr_setinheritsched(3)
 436             to set the inherit-scheduler attribute of the attributes object
 437             to PTHREAD_EXPLICIT_SCHED.
 438
 439 ptsname.3
 440     Peng Haitao
 441         ATTRIBUTES: Note function that is not thread-safe
 442             The function ptsname() is not thread safe.
 443
 444 putenv.3
 445     Michael Kerrisk
 446         RETURN VALUE: mention that 'errno' is set on error
 447
 448 putpwent.3
 449     Michael Kerrisk
 450         RETURN VALUE: mention that 'errno' is set on error
 451
 452 qecvt.3
 453     Peng Haitao
 454         ATTRIBUTES: Note functions that are not thread-safe
 455             The functions qecvt() and qfcvt() are not thread-safe.
 456
 457 random.3
 458     Michael Kerrisk
 459         RETURN VALUE: mention that 'errno' is set on error
 460     Michael Kerrisk
 461         Add EINVAL error for setstate()
 462     Michael Kerrisk
 463         BUGS: inistate() does not return NULL on error
 464             http://sourceware.org/bugzilla/show_bug.cgi?id=15380
 465
 466 random_r.3
 467     Michael Kerrisk
 468         RETURN VALUE: mention that 'errno' is set on error
 469
 470 readdir.3
 471     Peng Haitao
 472         ATTRIBUTES: Note functions that are not thread-safe
 473             The data returned by readdir() may be overwritten by subsequent
 474             calls to readdir() for the same directory stream, so it is not
 475             thread-safe.
 476
 477 re_comp.3
 478     Peng Haitao
 479         ATTRIBUTES: Note functions that are not thread-safe
 480             The functions re_comp() and re_exec() are not thread safe.
 481
 482 rexec.3
 483     Peng Haitao
 484         ATTRIBUTES: Note functions that are not thread-safe
 485             The functions rexec() and rexec_af() are not thread safe.
 486
 487 round.3
 488     Peng Haitao
 489         ATTRIBUTES: Note functions that are thread-safe
 490             The functions round(), roundf() and roundl() are thread safe.
 491
 492 scalbln.3
 493     Peng Haitao
 494         ATTRIBUTES: Note functions that are thread-safe
 495             The functions scalbn(), scalbnf(), scalbnl(), scalbln(),
 496             scalblnf() and scalblnl() are thread safe.
 497
 498 scandir.3
 499     Michael Kerrisk
 500         RETURN VALUE: mention that 'errno' is set on error
 501
 502 siginterrupt.3
 503     Michael Kerrisk
 504         RETURN VALUE: mention that 'errno' is set on error
 505
 506 signbit.3
 507     Peng Haitao
 508         ATTRIBUTES: Note macro that is thread-safe
 509             The macro signbit() is thread safe.
 510
 511 sigsetops.3
 512     Michael Kerrisk
 513         RETURN VALUE: mention that 'errno' is set on error
 514
 515 stdio_ext.3
 516     Peng Haitao
 517         ATTRIBUTES: Note functions that are not thread-safe
 518             The functions __fbufsize(), __fpending(), __fpurge() and
 519             __fsetlocking() are not thread safe.
 520
 521 strdup.3
 522     Michael Kerrisk
 523         RETURN VALUE: mention that 'errno' is set on error
 524
 525 strerror.3
 526     Peng Haitao
 527         ATTRIBUTES: Note function that is not thread-safe
 528             The function strerror() is not thread safe.
 529
 530 strftime.3
 531     Michael Kerrisk
 532         Clarify details of return value
 533     Michael Kerrisk
 534         BUGS: 'errno' is not set if the result string would exceed 'max' bytes
 535
 536 strtok.3
 537     Peng Haitao
 538         ATTRIBUTES: Note function that is not thread-safe
 539             The function strtok() is not thread safe.
 540     Michael Kerrisk  [Georg Sauthoff]
 541         Add more detail on the operation of strtok()
 542             Add a number of missing details on the operation of strtok()
 543
 544 tempnam.3
 545     Michael Kerrisk
 546         RETURN VALUE: mention that 'errno' is set on error
 547
 548 timegm.3
 549     Jérémie Galarneau
 550         copy the string returned by getenv()
 551             The example of a portable version of timegm() uses the string
 552             returned by getenv() after calling setenv() on the same
 553             environment variable. The tz string may be invalid as per
 554             getenv.3:
 555
 556                     "The string pointed to by the return value of getenv()
 557                      may be statically allocated, and can be modified by a
 558                      subsequent call to getenv(), putenv(3), setenv(3), or
 559                      unsetenv(3)."
 560
 561 tmpnam.3
 562     Peng Haitao
 563         ATTRIBUTES: Note function that is thread safe with exceptions
 564             The function tmpnam() is thread safe with exceptions.
 565
 566 trunc.3
 567     Peng Haitao
 568         ATTRIBUTES: Note functions that are thread-safe
 569             The functions trunc(), truncf() and truncl() are thread safe.
 570
 571 ttyname.3
 572     Michael Kerrisk
 573         ATTRIBUTES: Note functions that are and aren't thread-safe
 574
 575 ttyslot.3
 576     Michael Kerrisk
 577         ATTRIBUTES: Note functions that are not thread-safe
 578
 579 usleep.3
 580     Michael Kerrisk
 581         RETURN VALUE: mention that 'errno' is set on error
 582
 583 wcsdup.3
 584     Michael Kerrisk
 585         RETURN VALUE: mention that 'errno' is set on error
 586
 587 core.5
 588     Michael Kerrisk
 589         Implicitly adding the PID to a core filename was dropped in 2.6.27
 590
 591 proc.5
 592     Michael Kerrisk
 593         Document /proc/[pid]/fd/ anon_inode symlinks
 594     Mike Frysinger
 595         Document /proc/[pid]/fd/ symlinks a bit more
 596             Describe the type:[inode] syntax used in this dir
 597
 598 bootparam.7
 599     Michael Kerrisk  [Dan Jacobson]
 600         Remove outdated text on LILO and LoadLin
 601             Strike the discussion of LILO and LoadLin, which
 602             are long obsolete, and make a brief mention of GRUB.
 603             See http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=604019
 604     Regid
 605         Remove mention of the deprecated rdev(8)
 606             The deprecated rdev(8) command was removed from util-linux in 2010.
 607             See https://git.kernel.org/?p=utils/util-linux/util-linux.git;a=commit;h=a3e40c14651fccf18e7954f081e601389baefe3fO
 608     Andrea Remondini
 609         Document the 'resume' boot parameter
 610
 611 inotify.7
 612     Michael Kerrisk  [Jon Grant]
 613         Clarify that null byte is '\0'
 614
 615 iso_8859-2.7
 616     Eric S. Raymond
 617         Remove incorrect reference to nonexistent groff glyph \[shc]
 618             The reference incorrectly attempted to duplicate an
 619             actual soft hyphen (hex 0xad) just before it in the file.
 620
 621 man-pages.7
 622     Peng Haitao
 623         Add description of "ATTRIBUTES"
 624             "ATTRIBUTES" section can mention thread safety,
 625             cancellation safety, and async-cancel-safety.
 626
 627 socket.7
 628     Michael Kerrisk
 629         Note that 'optval' for socket options is an 'int' in most cases
 630
 631 tcp.7
 632     Michael Kerrisk
 633         Note that 'optval' for socket options is an 'int' in most cases
 634
 635 udp.7
 636     Michael Kerrisk
 637         Note that 'optval' for socket options is an 'int' in most cases