about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2017-03-12 22:30:41 -0700
committerRical Jasan <ricaljasan@pacific.net>2017-06-15 21:26:19 -0700
commit27691d5cec9b896ea0792151a27c6d7d7a4065ea (patch)
tree28ace0635b22915bd9cde4ddc3cc91b941558ed6
parent48d966eb359b559f292b7f6896eff7746e5af390 (diff)
downloadglibc-27691d5cec9b896ea0792151a27c6d7d7a4065ea.tar.gz
glibc-27691d5cec9b896ea0792151a27c6d7d7a4065ea.tar.xz
glibc-27691d5cec9b896ea0792151a27c6d7d7a4065ea.zip
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.
-rw-r--r--ChangeLog6
-rw-r--r--manual/macros.texi7
2 files changed, 13 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 3255a1fdf2..3360344686 100644
--- 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.
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