This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH v4 2/5] 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: Fri, 19 May 2017 02:33:50 -0700
- Subject: [PATCH v4 2/5] manual: Create empty placeholder macros for @standards.
- Authentication-results: sourceware.org; auth=none
- References: <cover.1494920105.git.ricaljasan@pacific.net> <20170519093353.6158-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 provide separate annotations for lists of
@*x elements, where a common description is shared. 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 9cf8031d69..9c4326b108 100644
--- a/manual/macros.texi
+++ b/manual/macros.texi
@@ -267,4 +267,11 @@ cwd\comments\
@end macro
@end ifnottex
+@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