2022-12-22 20:49:24

by Alejandro Colomar

[permalink] [raw]
Subject: man-pages-6.02 released

Gidday!

I'm proud to announce:

man-pages-6.02 - manual pages for GNU/Linux

The release tarball is already available on <kernel.org>.

Tarball download:
<https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/>
Git repository:
<https://git.kernel.org/cgit/docs/man-pages/man-pages.git/>

The most notable changes in this release are the following:

- Rewritten pages for string-copying functions. These now use
consistent language. Also added a new string_copying(7) page that
serves as an overview of all such functions, compares them, and
details which is appropriate for which uses.

- Use _Nullable for documenting which functions accept NULL as a
meaningful value in the function prototypes in the SYNOPSIS.

- Use VLA syntax for documenting function parameters that are treated
as arrays. This uses syntax not accepted by compilers.

- Rewritten repository documentation (README, CONTRIBUTING, INSTALL, ...).

- Documentation for new APIs, such as MADV_COLLAPSE in madvise(2).

Thank you all for contributing.

- There's also a repository change that is not part of this release: Historic
versions of the project going back to man-pages-1.0 have been added to the git
repository in a 'prehistory' branch.

Cheers,

Alex

==================== Changes in man-pages-6.02 ====================

Released: 2022-12-22, Aldaya


Contributors
------------

The following people contributed patches/fixes, reports, notes,
ideas, and discussions that have been incorporated in changes in
this release:


"G. Branden Robinson" <[email protected]>
1092615079 <[email protected]>
Aaron Schrab <[email protected]>
Agostino Sarubbo <[email protected]>
Ahelenia Ziemiańska <[email protected]>
Alejandro Colomar <[email protected]>
Alex Colomar <[email protected]>
Amir Goldstein <[email protected]>
Andrew Clayton <[email protected]>
Andrew Pinski <[email protected]>
Andries E. Brouwer <[email protected]>
Darrick J. Wong <[email protected]>
Douglas McIlroy <[email protected]>
Eric Biggers <[email protected]>
Florian Weimer <[email protected]>
G. Branden Robinson <[email protected]>
Grigoriy <[email protected]>
Grzegorz Szymaszek <[email protected]>
Helge Kreutzmann <[email protected]>
Ian Abbott <[email protected]>
Iker Pedrosa <[email protected]>
Ingo Schwarze <[email protected]>
Jakub Wilk <[email protected]>
Jan Kara <[email protected]>
JeanHeyd Meneide <[email protected]>
Jun Ishiguro <[email protected]>
Luca Versari <[email protected]>
Luis Javier Merino <[email protected]>
Mario Blättermann <[email protected]>
Martin Sebor <[email protected]>
Martin Uecker <[email protected]>
Matthew Bobrowski <[email protected]>
Michael Kerrisk <[email protected]>
Michael Tokarev <[email protected]>
Mike Frysinger <[email protected]>
Mike Gilbert <[email protected]>
Minchan Kim <[email protected]>
Nicolás A. Ortega Froysa <[email protected]>
Pali Rohár <[email protected]>
Pierre Labastie <[email protected]>
Sam James <[email protected]>
Serge Hallyn <[email protected]>
Stefan Puiu <[email protected]>
Steve Izma <[email protected]>
Suren Baghdasaryan <[email protected]>
Thomas Voss <[email protected]>
Tycho Andersen <[email protected]>
Xi Ruoyao <[email protected]>
Zach O'Keefe <[email protected]>
Zack Weinberg <[email protected]>


Apologies if I missed anyone!


New and rewritten pages
-----------------------

man3/
static_assert.3
strcpy.3
stpncpy.3
strncat.3

man3const/
EOF.3const
EXIT_SUCCESS.3const

man7/
string_copying.7


Newly documented interfaces in existing pages
---------------------------------------------

ioctl_tty.2
TIOCSERGETLSR
TIOCSER_TEMT

madvise.2
MADV_COLLAPSE

syscall.2
loongarch


New and changed links
---------------------

man3/
_Static_assert.3 (static_assert(3))
stpcpy.3 (strcpy(3))
strcat.3 (strcpy(3))
strncpy.3 (stpncpy(3))
stpecpy.3 (string_copying(7))
stpecpyx.3 (string_copying(7))
ustpcpy.3 (string_copying(7))
ustr2stp.3 (string_copying(7))
zustr2stp.3 (string_copying(7))
zustr2ustp.3 (string_copying(7))

man3const/
EXIT_FAILURE.3const (EXIT_SUCCESS(3const))


Global changes
--------------

- Use correct letter case in manual page titles, instead of uppercase.

- Use \" t comments when appropriate (Lintian needs this).

- SYNOPSIS:

- Add _Nullable for functions that receive NULL as a meaningful
input.

- Use VLA syntax to clarify the meaning of size parameters, rather
than hiding it in possibly-confusing text. This syntax is not
accepted by any compilers, though.

- Use [[noreturn]] instead of noreturn, which will be deprecated
soon.

- Repository documentation:

- Added significant documentation about the repository and the
project in the root of the repository in different files.
Starting from the README, anyone passing by should be able to
understand how the project works and be directed to other
documentation files. These files also document the release
process.

- Michael has been busy lately, and he is no longer maintaining
the project. The in-repository documentation mentioned above has
been updated to reflect that.


Changes to individual pages
---------------------------

copy_file_range.2
Fix wrong kernel version information

process_madvise.2
Fix capability and ptrace requirements

madvise.2
Update Transparent Huge Pages file/shmem documentation for
Linux 5.4+.


The manual pages (and other files in the repository) have been improved
beyond what this changelog covers. To learn more about changes applied
to individual pages, use git(1).


--
<http://www.alejandro-colomar.es/>


Attachments:
OpenPGP_signature (849.00 B)
OpenPGP digital signature