This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH v5 1/3] manual: Create empty placeholder macros for @standards.
- From: Rical Jasan <ricaljasan at pacific dot net>
- To: libc-alpha at sourceware dot org
- Cc: Joseph Myers <joseph at codesourcery dot com>, Carlos O'Donell <carlos at redhat dot com>, Michael Kerrisk <mtk dot manpages at gmail dot com>, Zack Weinberg <zackw at panix dot com>
- Date: Thu, 25 May 2017 21:58:48 -0700
- Subject: [PATCH v5 1/3] manual: Create empty placeholder macros for @standards.
- Authentication-results: sourceware.org; auth=none
- References: <20170519093353.6158-1-ricaljasan@pacific.net> <20170526045850.30455-1-ricaljasan@pacific.net>
Header and standards annotations are slated for standardization,
including being rendered in the description of functions, variables,
etc. (elements), and eventually required. This commit adds @standards
dummy macros so we can convert all existing annotations to the new
framework while maintaining the rendered status quo.
There needs to be a way to disambiguate annotations in lists of @*x
elements, where a common description is shared but some elements may
have different headers or standards. The @standardsx macro fills this
role by accepting an additional parameter: the name of the annotated
element.
* manual/macros.texi (@standards): New macro. Provide
placeholder for header and standards annotations.
(@standardsx): New macro. Likewise, for lists of @*x
elements.
---
manual/macros.texi | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/manual/macros.texi b/manual/macros.texi
index 6496f2e177..0b073908f1 100644
--- a/manual/macros.texi
+++ b/manual/macros.texi
@@ -273,4 +273,11 @@ cwd\comments\
@cindex \str\
@end macro
+@c Dummy placeholder while converting annotations.
+@macro standards {standard, header}
+@end macro
+@c To be used for @*x lists of elements.
+@macro standardsx {element, standard, header}
+@end macro
+
@end ifclear