Commit Graph

7 Commits

Author SHA1 Message Date
Rical Jasan
3e6def237a manual: Provide consistent errno documentation.
The @errno macro is extended to render the canonical error string in
every documented errno error.  Redundant entries and "???" are
removed.  Sixty-six errors now at least contain the error string as
the description, where no description (or "???") existed before.

	* manual/errno.texi: Remove redundant error strings.
	* manual/macros.texi (@errno): Render the error string in
	every description.
2017-06-02 13:49:20 -07:00
Rical Jasan
a429d2ff07 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.
2017-05-19 22:47:53 -07:00
Ondřej Bílka
9ceeb27931 Fix exponents in manual.
* manual/macros.texi: Add twoexp macro.
	* manual/filesys.texi: Fix exponents.
	* manual/llio.texi: Likewise.
	* manual/stdio.texi: Likewise.
2015-08-20 09:43:50 +02:00
Alexandre Oliva
375592d364 * manual/macros.texi: Add comments before MTASC-safety macros. 2014-02-03 17:26:08 -02:00
Alexandre Oliva
0a57b83e4a * manual/macros.texi: Introduce macros to document multi
thread, asynchronous signal and asynchronous cancellation
safety properties.
* manual/intro.texi: Introduce the properties themselves.
2014-01-29 05:20:37 -02:00
Joseph Myers
a7a93d5086 Clean up glibc manual references to "GNU system" (bug 6911). 2012-03-08 01:27:38 +00:00
Joseph Myers
1f77f0491f Use Texinfo macros to refer to the GNU C Library within the manual. 2012-02-28 14:44:20 +00:00