]> git.ipfire.org Git - thirdparty/glibc.git/commitdiff
manual: Create empty placeholder macros for @standards.
authorRical Jasan <ricaljasan@pacific.net>
Mon, 13 Mar 2017 05:30:41 +0000 (22:30 -0700)
committerRical Jasan <ricaljasan@pacific.net>
Fri, 16 Jun 2017 04:26:19 +0000 (21:26 -0700)
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.

ChangeLog
manual/macros.texi

index 3255a1fdf239c494fa888da95b7837e0c123eaa8..3360344686e483da753e38b67453564032b855fe 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2017-06-15  Rical Jasan  <ricaljasan@pacific.net>
+
+       * manual/macros.texi (@standards): New macro.  Provide placeholder
+       for header and standards annotations.
+       (@standardsx): New macro.  Likewise, for lists of @*x elements.
+
 2017-06-15  Adhemerval Zanella  <adhemerval.zanella@linaro.org>
 
        * io/Makefile (CFLAGS-sync_file_range.c): Remove rule.
index 2e0990eac26b199626ed97d0e55b95429f33c62d..170e954a50aad55580d4b2c2595a5adcdd291e8e 100644 (file)
@@ -274,4 +274,11 @@ cwd\comments\
 ``\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