]> git.ipfire.org Git - thirdparty/glibc.git/commit
manual: Convert errno @comments to new @errno macro.
authorRical Jasan <ricaljasan@pacific.net>
Sat, 20 May 2017 05:44:25 +0000 (22:44 -0700)
committerRical Jasan <ricaljasan@pacific.net>
Sat, 20 May 2017 05:47:53 +0000 (22:47 -0700)
commita429d2ff07fcb6620269fc0ee46ea5066451fdff
treeb331d57677d3181b3d025a22682fd1fd0d4b3443
parent0bcec5321f7d31c31e4fd601d4e0922862d87b14
manual: Convert errno @comments to new @errno macro.

errno.texi documents error macros, their values, and error strings in
Texinfo @comments, some of which are also used for @standards.  The
purpose of this commit is to separate the standards from the error
strings so that both the @standards conversion script picks up clean
@standards and the errno documentation framework is improved.

The error names, values, and messages are consolidated in a new custom
macro, @errno.  It is not clear that scripts within the sources rely
on the special Texinfo @comment-based format to generate files used
throughout the library, so the definition of @errno in macros.texi now
provides a comment indicating the dependency.  The dependent scripts
are updated to use @errno, which also simplifies them a bit.  The
files those scripts generate were verified to be unchanged.

The @errno macro is not visibly rendered in any way at this time, but
it does use an @cindex command to add the error string to the Concept
Index, to facilitate searching on error messages.

* manual/errno.texi: Convert @comment-based errno
documentation to @errno.
* manual/macros.texi (@errno): New macro.  Consolidate errors,
their values, and messages, adding the error string to the
Concept Index.  Provide a warning in the comment about
external (to the manual) dependencies.
* sysdeps/gnu/errlist.awk: Use @errno instead of @comments.
* sysdeps/mach/hurd/errnos.awk: Likewise.
ChangeLog
manual/errno.texi
manual/macros.texi
sysdeps/gnu/errlist.awk
sysdeps/mach/hurd/errnos.awk