This is the mail archive of the newlib@sourceware.org mailing list for the newlib project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH 01/11] Fix makedoc markup used in texinfo source


On 24/06/2015 10:59, Corinna Vinschen wrote:
On Jun 23 20:49, Jon TURNEY wrote:
2015-06-23  Jon Turney

	* libc/signal/signal.tex: Use texinfo not makedoc markup.
	* libc/stdio/stdio.tex: Ditto.

Ok.

Thanks,

Thanks for the review.

For completeness, I also noted the following issues with the newlib documentation:

makedoc's doc.str contains no processing instructions for 'NOTES', but locale.c, mktemp.c, rand.c strtok.c and wcstok.c all have 'NOTES', which look like they are intended to be read, but are currently being discarded.

In some (ANSI_|)SYNOPSIS sections, the prototypes are not terminated by a ';'

Some FUNCTION sections separate the function names from the one-line description with a '--' rather than an '---'. This is typographically distinct markup (an en-dash rather than an em-dash).

Some QUICKREF sections have their contents on the same line as the command, rather than following it, which is not processable by makedoc. This is benign, as QUICKREF is currently discarded by makedoc.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]