[RFC] [PATCH v3] manual: @standards macro
Rical Jasan
ricaljasan@pacific.net
Wed Feb 8 10:36:00 GMT 2017
Here is a simple take on the @standards macro, modelled after the
suggestion in [1].
I put it directly under the function/variable/etc., and above @safety,
because the @safety annotations are often followed by comments,
sometimes more than a screenfull's worth. Doing it that way keeps all
the annotations clearly grouped together, and is also visually
consistent with non-functions, which will have @standards directly below
them since they don't have @safety annotations.
In the macro definition, I use "@sp 0" to force a paragraph break
without adding extra blank lines. It accomplishes the same thing as two
blank lines within the macro definition but keeps the "@end macro" more
closely tied to the block of code it relates to, which is nice. I don't
really have an opinion on its use; I was just sure Texinfo provided a
way to force a paragraph break, so I was playing with it. It does cost
a couple extra bytes. :)
On the formatting of the output, specifically, listing "STD (HDR)", I
would like to point out the Summary does exactly the opposite.
Rical
-------------- next part --------------
A non-text attachment was scrubbed...
Name: standards-macro-rfc.patch
Type: text/x-patch
Size: 1499 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/libc-alpha/attachments/20170208/36b56342/attachment.bin>
More information about the Libc-alpha
mailing list