This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH v2 1/5] manual: Refactor header and standards annotations.
- From: Rical Jasan <ricaljasan at pacific dot net>
- To: libc-alpha at sourceware dot org
- Cc: joseph at codesourcery dot com, mtk dot manpages at gmail dot com, carlos at redhat dot com
- Date: Tue, 6 Dec 2016 02:55:21 -0800
- Subject: [PATCH v2 1/5] manual: Refactor header and standards annotations.
- Authentication-results: sourceware.org; auth=none
- References: <20161206105525.21117-1-ricaljasan@pacific.net>
This commit handles some initial cleanup, making sure any
existing header and standards annotations conform to the
expected syntax.
* manual/filesys.texi: Refactor code in preparation for future
work on header and standards annotations.
* manual/llio.texi: Likewise.
* manual/locale.texi: Likewise.
* manual/time.texi: Likewise.
* manual/users.texi: Likewise.
---
manual/filesys.texi | 2 +-
manual/llio.texi | 2 +-
manual/locale.texi | 2 +-
manual/time.texi | 2 +-
manual/users.texi | 6 ++----
5 files changed, 6 insertions(+), 8 deletions(-)
diff --git a/manual/filesys.texi b/manual/filesys.texi
index 26758e6..dc047c0 100644
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -3559,9 +3559,9 @@ opening the file you should use the @code{O_EXCL} flag. Using
@end deftypefun
@cindex TMPDIR environment variable
+@c !!! are we putting SVID/GNU/POSIX.1/BSD in here or not??
@comment stdio.h
@comment SVID
-@c !!! are we putting SVID/GNU/POSIX.1/BSD in here or not??
@deftypevr {SVID Macro} {char *} P_tmpdir
This macro is the name of the default directory for temporary files.
@end deftypevr
diff --git a/manual/llio.texi b/manual/llio.texi
index e2697aa..e4524bc 100644
--- a/manual/llio.texi
+++ b/manual/llio.texi
@@ -938,9 +938,9 @@ file descriptors belonging to the standard streams @code{stdin},
@code{stdout}, and @code{stderr}; see @ref{Standard Streams}.
@pindex unistd.h
+@table @code
@comment unistd.h
@comment POSIX.1
-@table @code
@item STDIN_FILENO
@vindex STDIN_FILENO
This macro has value @code{0}, which is the file descriptor for
diff --git a/manual/locale.texi b/manual/locale.texi
index 780ce01..ae71ccc 100644
--- a/manual/locale.texi
+++ b/manual/locale.texi
@@ -1406,8 +1406,8 @@ English.
@Theglibc{} contains @code{rpmatch} to give applications easy
access to the corresponding locale definitions.
-@comment GNU
@comment stdlib.h
+@comment GNU
@deftypefun int rpmatch (const char *@var{response})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@asucorrupt{} @ascuheap{} @asulock{} @ascudlopen{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
@c Calls nl_langinfo with YESEXPR and NOEXPR, triggering @mtslocale but
diff --git a/manual/time.texi b/manual/time.texi
index 6a899b7..e590c77 100644
--- a/manual/time.texi
+++ b/manual/time.texi
@@ -2740,9 +2740,9 @@ by @var{which} in the structure pointed at by @var{old}.
The return value and error conditions are the same as for @code{setitimer}.
@end deftypefun
+@vtable @code
@comment sys/time.h
@comment BSD
-@vtable @code
@item ITIMER_REAL
This constant can be used as the @var{which} argument to the
@code{setitimer} and @code{getitimer} functions to specify the real-time
diff --git a/manual/users.texi b/manual/users.texi
index 0d94db1..0924f39 100644
--- a/manual/users.texi
+++ b/manual/users.texi
@@ -1674,8 +1674,7 @@ You can translate between a traditional @code{struct utmp} and an XPG
these functions are merely copies, since the two structures are
identical.
-@comment utmpx.h
-@comment utmp.h
+@comment utmp.h utmpx.h
@comment GNU
@deftypefun int getutmp (const struct utmpx *@var{utmpx}, struct utmp *@var{utmp})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@@ -1683,8 +1682,7 @@ identical.
compatible, from @var{utmpx} to @var{utmp}.
@end deftypefun
-@comment utmpx.h
-@comment utmp.h
+@comment utmp.h utmpx.h
@comment GNU
@deftypefun int getutmpx (const struct utmp *@var{utmp}, struct utmpx *@var{utmpx})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}