diff mbox

[v5,1/3] manual: Create empty placeholder macros for @standards.

Message ID 20170526045850.30455-2-ricaljasan@pacific.net
State New
Headers show

Commit Message

Rical Jasan May 26, 2017, 4:58 a.m. UTC 
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 mbox

Patch

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