picnoir
/
glibc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Rical Jasan 2017-03-12 22:30:41 -07:00
parent 48d966eb35
commit 27691d5cec
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -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.

7
manual/macros.texi
View 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