From a429d2ff07fcb6620269fc0ee46ea5066451fdff Mon Sep 17 00:00:00 2001 From: Rical Jasan Date: Fri, 19 May 2017 22:44:25 -0700 Subject: 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. --- manual/macros.texi | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'manual/macros.texi') 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 -- cgit v1.2.3