[PATCH v2 4/5] manual: Enforce header and standard requirements.

Rical Jasan ricaljasan@pacific.net
Tue Dec 6 10:55:00 GMT 2016


	Introduces a new script, check-stds.pl, which examines the
	immediately preceding lines of entries requiring annotation
	for valid header and standard annotations.

	Only two classes of entries can currently be known to require
	annotation: @def*-commands and @item entries within @vtables.
	Note that summary.awk also indexes @vindex entries, but this
	script does not enforce any requirements upon them, as they
	are better addressed by reworking the documentation in more
	significant ways (than conversion of @vindexed @items in
	@tables to @items in @vtables, for example).

	Standards are essentially free-form, and headers must look
	like *.h, and multiple headers may not be comma-separated.

	The syntax comment in summary.awk is updated, and the new
	script is added to the Makefile.  It exits with error
	(printing any) in case of trouble, so this should help prevent
	new errors from creeping in.

	* manual/check-stds.pl: New file.  Check anything that we can
	know deserves header/standard annotation, and report errors.
	* manual/Makefile: Use check-stds.pl.
	* manual/summary.awk: Update comment about syntax.
---
 manual/Makefile      |   1 +
 manual/check-stds.pl | 211 +++++++++++++++++++++++++++++++++++++++++++++++++++
 manual/summary.awk   |   3 +-
 3 files changed, 214 insertions(+), 1 deletion(-)
 create mode 100755 manual/check-stds.pl

-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0004-manual-Enforce-header-and-standard-requirements.patch
Type: text/x-patch
Size: 5999 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/libc-alpha/attachments/20161206/b91d4fb8/attachment.bin>


More information about the Libc-alpha mailing list