[PATCH 1/3] manual: Refactor header and standards annotations.

Rical Jasan ricaljasan@pacific.net
Wed Nov 23 06:38:00 GMT 2016


manual: Refactor header and standards annotations.

	This commit handles some initial cleanup, making sure any
	existing header and standards annotations conform, while
	fixing 1 entry in the Summary of Library Facilities and
	improving 2 others.

	Multiple headers may be defined as long as they are all on the
	second-to-last line, and not separated by commas.  Standards
	are rendered free-form, so there is no need to refactor them
	as long as they are present.

	Deviating from summary.awk, the header and standards
	annotations must occur on the two lines immediately preceding
	the item to be annotated (this simplifies future work and
	doesn't change summary.awk's output).  Additionally, @comments
	immediately preceding header and standards @comments are
	disallowed (note that @c-comments are still valid).  The
	latter requirement may not be essential once all annotations
	are otherwise conforming, but it was useful as a heuristic for
	finding ill-formatted annotations in the meantime, enforcing a
	stricter syntax that is still summary.awk-compatible.

	* manual/filesys.texi: Refactor code in preparation for future
	work on header and standards annotations.
	* manual/lang.texi: Likewise.
	* manual/locale.texi: Likewise.
	* manual/time.texi: Likewise.
	* manual/users.texi: Likewise.
---
 manual/filesys.texi | 2 +-
 manual/lang.texi    | 2 +-
 manual/locale.texi  | 2 +-
 manual/time.texi    | 2 +-
 manual/users.texi   | 6 ++----
 5 files changed, 6 insertions(+), 8 deletions(-)

-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-manual-Refactor-header-and-standards-annotations.patch
Type: text/x-patch
Size: 2941 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/libc-alpha/attachments/20161123/af4dde9e/attachment.bin>


More information about the Libc-alpha mailing list