From 27691d5cec9b896ea0792151a27c6d7d7a4065ea Mon Sep 17 00:00:00 2001 From: Rical Jasan Date: Sun, 12 Mar 2017 22:30:41 -0700 Subject: [PATCH] manual: Create empty placeholder macros for @standards. 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 | 6 ++++++ manual/macros.texi | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/ChangeLog b/ChangeLog index 3255a1fdf2..3360344686 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2017-06-15 Rical Jasan + + * 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 * io/Makefile (CFLAGS-sync_file_range.c): Remove rule. diff --git a/manual/macros.texi b/manual/macros.texi index 2e0990eac2..170e954a50 100644 --- a/manual/macros.texi +++ b/manual/macros.texi @@ -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