diff options
author | Rical Jasan <ricaljasan@pacific.net> | 2017-05-19 22:44:25 -0700 |
---|---|---|
committer | Rical Jasan <ricaljasan@pacific.net> | 2017-05-19 22:47:53 -0700 |
commit | a429d2ff07fcb6620269fc0ee46ea5066451fdff (patch) | |
tree | b331d57677d3181b3d025a22682fd1fd0d4b3443 /manual/macros.texi | |
parent | 0bcec5321f7d31c31e4fd601d4e0922862d87b14 (diff) | |
download | glibc-a429d2ff07fcb6620269fc0ee46ea5066451fdff.tar glibc-a429d2ff07fcb6620269fc0ee46ea5066451fdff.tar.gz glibc-a429d2ff07fcb6620269fc0ee46ea5066451fdff.tar.bz2 glibc-a429d2ff07fcb6620269fc0ee46ea5066451fdff.zip |
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.
Diffstat (limited to 'manual/macros.texi')
-rw-r--r-- | manual/macros.texi | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/manual/macros.texi b/manual/macros.texi index 9cf8031d69..6496f2e177 100644 --- a/manual/macros.texi +++ b/manual/macros.texi @@ -267,4 +267,10 @@ cwd\comments\ @end macro @end ifnottex +@c Used by errlist.awk and errnos.awk to generate other files. +@c Note that error values have ABI implications for the Hurd. +@macro errno {err, val, str} +@cindex \str\ +@end macro + @end ifclear |