From: Rical Jasan <ricaljasan@pacific.net>
To: libc-alpha@sourceware.org
Cc: Joseph Myers <joseph@codesourcery.com>,
Carlos O'Donell <carlos@redhat.com>,
Michael Kerrisk <mtk.manpages@gmail.com>
Subject: [PATCH v3 3/7] manual: Fix up invalid header and standards syntax.
Date: Tue, 16 May 2017 09:55:00 -0000 [thread overview]
Message-ID: <8c0dcc1290c7f685de0af20655223702ace586b7.1494920105.git.ricaljasan@pacific.net> (raw)
In-Reply-To: <cover.1494920105.git.ricaljasan@pacific.net>
[-- Attachment #1: Type: text/plain, Size: 773 bytes --]
This commit handles exceptional cases of invalid syntax for the
@standards conversion script.
* manual/crypt.texi: Move a comment out of an @*x list.
* manual/filesys.texi: Refactor some comments, one of which
looks like a standard. Fix incorrectly separated standards.
* manual/locale.texi: Invert an annotation.
* manual/resource.texi: Fix incorrectly separated standards.
* manual/time.texi: Refactor a @vtable that obscures an
annotation.
* manual/users.texi: Refactor multiple headers to occupy a
single @comment.
---
manual/crypt.texi | 2 +-
manual/filesys.texi | 8 ++++----
manual/locale.texi | 2 +-
manual/resource.texi | 4 ++--
manual/time.texi | 2 +-
manual/users.texi | 6 ++----
6 files changed, 11 insertions(+), 13 deletions(-)
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0003-manual-Fix-up-invalid-header-and-standards-syntax.patch --]
[-- Type: text/x-patch; name="0003-manual-Fix-up-invalid-header-and-standards-syntax.patch", Size: 5381 bytes --]
diff --git a/manual/crypt.texi b/manual/crypt.texi
index 4ab512bb37..59e42652ab 100644
--- a/manual/crypt.texi
+++ b/manual/crypt.texi
@@ -290,10 +290,10 @@ stored in a @code{char}, but there are no parity bits in @var{block}.
@comment crypt.h
@comment GNU
@deftypefun void setkey_r (const char *@var{key}, {struct crypt_data *} @var{data})
-@c @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{} @asulock{}}@acunsafe{@aculock{}}}
@comment crypt.h
@comment GNU
@deftypefunx void encrypt_r (char *@var{block}, int @var{edflag}, {struct crypt_data *} @var{data})
+@c setkey_r: @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{} @asulock{}}@acunsafe{@aculock{}}}
@safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{} @asulock{}}@acunsafe{@aculock{}}}
These are reentrant versions of @code{setkey} and @code{encrypt}. The
diff --git a/manual/filesys.texi b/manual/filesys.texi
index a255c8f07c..e3fe323f47 100644
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -716,7 +716,7 @@ entries in a directory, possibly sort them and get a list of names as
the result.
@comment dirent.h
-@comment BSD/SVID
+@comment BSD, SVID
@deftypefun int scandir (const char *@var{dir}, struct dirent ***@var{namelist}, int (*@var{selector}) (const struct dirent *), int (*@var{cmp}) (const struct dirent **, const struct dirent **))
@safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{} @acsfd{}}}
@c The scandir function calls __opendirat, __readdir, and __closedir to
@@ -759,7 +759,7 @@ programmer @theglibc{} contains implementations of functions which
are very helpful for this purpose.
@comment dirent.h
-@comment BSD/SVID
+@comment BSD, SVID
@deftypefun int alphasort (const struct dirent **@var{a}, const struct dirent **@var{b})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
@c Calls strcoll.
@@ -1315,8 +1315,8 @@ The directory or file system cannot be extended to make the new link.
@item EIO
A hardware error occurred while reading or writing data on the disk.
-@ignore
@comment not sure about these
+@ignore
@item ELOOP
There are too many levels of indirection. This can be the result of
circular symbolic links to directories.
@@ -3543,9 +3543,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/locale.texi b/manual/locale.texi
index 780ce0145f..ae71ccc906 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/resource.texi b/manual/resource.texi
index bf9337553c..2328045ac0 100644
--- a/manual/resource.texi
+++ b/manual/resource.texi
@@ -1161,7 +1161,7 @@ The highest valid nice value.
@end vtable
@comment sys/resource.h
-@comment BSD,POSIX
+@comment BSD, POSIX
@deftypefun int getpriority (int @var{class}, int @var{id})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Direct syscall on UNIX. On HURD, calls _hurd_priority_which_map.
@@ -1190,7 +1190,7 @@ afterward as the criterion for failure.
@end deftypefun
@comment sys/resource.h
-@comment BSD,POSIX
+@comment BSD, POSIX
@deftypefun int setpriority (int @var{class}, int @var{id}, int @var{niceval})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Direct syscall on UNIX. On HURD, calls _hurd_priority_which_map.
diff --git a/manual/time.texi b/manual/time.texi
index 2fb9232f95..dccb979955 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 433eeadf3d..47e28febdc 100644
--- a/manual/users.texi
+++ b/manual/users.texi
@@ -1655,8 +1655,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{}}
@@ -1664,8 +1663,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{}}
next prev parent reply other threads:[~2017-05-16 9:55 UTC|newest]
Thread overview: 91+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-06 10:55 [PATCH v2 0/5] Header & Standards Cleanup Rical Jasan
2016-12-06 10:55 ` [PATCH v2 1/5] manual: Refactor header and standards annotations Rical Jasan
2016-12-06 13:49 ` Zack Weinberg
2016-12-06 15:33 ` Joseph Myers
2016-12-19 10:37 ` Rical Jasan
2016-12-19 13:48 ` Joseph Myers
2017-02-07 6:46 ` Rical Jasan
2016-12-06 10:55 ` [PATCH v2 2/5] manual: Convert @tables of variables to @vtables Rical Jasan
2016-12-06 13:50 ` Zack Weinberg
2016-12-06 15:46 ` Joseph Myers
2016-12-07 15:18 ` Nix
2016-12-08 1:38 ` Rical Jasan
2016-12-21 10:08 ` Rical Jasan
2016-12-21 12:42 ` Joseph Myers
2016-12-06 10:55 ` [PATCH v2 4/5] manual: Enforce header and standard requirements Rical Jasan
2016-12-06 10:56 ` [PATCH v2 3/5] manual: Add new header and standards annotations Rical Jasan
2016-12-06 13:23 ` Zack Weinberg
2016-12-06 14:27 ` Andreas Schwab
2016-12-06 16:24 ` Joseph Myers
2016-12-06 19:23 ` Zack Weinberg
2016-12-06 21:42 ` Joseph Myers
2016-12-07 16:32 ` Joseph Myers
2016-12-08 2:56 ` Rical Jasan
2016-12-08 14:02 ` Joseph Myers
2016-12-12 9:01 ` Rical Jasan
2016-12-14 18:18 ` Joseph Myers
2016-12-14 23:30 ` Rical Jasan
2016-12-15 9:58 ` Rical Jasan
2016-12-15 13:01 ` Joseph Myers
2017-02-07 5:13 ` Rical Jasan
2017-02-07 16:41 ` Joseph Myers
2017-02-08 8:50 ` Rical Jasan
2017-02-08 13:52 ` Joseph Myers
2017-02-12 6:01 ` Rical Jasan
2017-04-04 3:58 ` Rical Jasan
2017-04-04 11:26 ` Joseph Myers
2017-04-05 3:08 ` Rical Jasan
2017-06-16 13:40 ` Zack Weinberg
2017-06-16 8:28 ` Rical Jasan
2016-12-06 11:42 ` [PATCH v2 5/5] manual: Clean up miscellaneous standards Rical Jasan
2017-05-16 9:55 ` [PATCH v3 0/7] manual: Header & Standards Cleanup Rical Jasan
2017-05-16 9:55 ` [PATCH v3 2/7] manual: Create empty placeholder macros for @standards Rical Jasan
2017-05-16 9:55 ` [PATCH v3 1/7] manual: Provide one-off standards conversion script Rical Jasan
2017-05-16 9:55 ` Rical Jasan [this message]
2017-05-16 11:51 ` [PATCH v3 3/7] manual: Fix up invalid header and standards syntax Joseph Myers
2017-05-17 4:49 ` Rical Jasan
2017-05-17 10:03 ` Joseph Myers
2017-05-18 8:10 ` Rical Jasan
2017-05-16 10:27 ` [PATCH v3 7/7] manual: Replace summary.awk with summary.pl Rical Jasan
2017-05-16 10:28 ` [PATCH v3 5/7] manual: Convert @tables of annotated @items to @vtables Rical Jasan
2017-05-16 11:53 ` Joseph Myers
2017-05-18 8:11 ` Rical Jasan
2017-05-16 10:28 ` [PATCH v3 6/7] manual: Convert header and standards @comments to @standards Rical Jasan
2017-05-16 10:29 ` [PATCH v3 4/7] manual: Refactor errno @comments Rical Jasan
2017-05-16 11:06 ` Joseph Myers
2017-05-17 4:44 ` Rical Jasan
2017-05-17 13:21 ` Zack Weinberg
2017-05-17 13:31 ` Zack Weinberg
2017-05-18 9:42 ` Rical Jasan
2017-05-18 12:32 ` Zack Weinberg
2017-05-19 9:46 ` Rical Jasan
2017-05-19 20:50 ` Zack Weinberg
2017-05-19 6:20 ` Rical Jasan
2017-05-18 9:58 ` Rical Jasan
2017-05-19 9:33 ` [PATCH v4 0/5] manual: Header & Standards Cleanup Rical Jasan
2017-05-19 9:33 ` [PATCH v4 2/5] manual: Create empty placeholder macros for @standards Rical Jasan
2017-05-19 21:02 ` Zack Weinberg
2017-05-20 6:05 ` Rical Jasan
2017-05-19 9:34 ` [PATCH v4 5/5] manual: Replace summary.awk with summary.pl Rical Jasan
2017-05-19 9:34 ` [PATCH v4 1/5] manual: Provide one-off standards conversion script Rical Jasan
2017-05-19 9:34 ` [PATCH v4 3/5] manual: Convert errno @comments to new @errno macro Rical Jasan
2017-05-19 21:03 ` Zack Weinberg
2017-05-20 6:05 ` Rical Jasan
2017-05-19 9:36 ` [PATCH v4 4/5] manual: Convert header and standards @comments to @standards Rical Jasan
2017-05-19 21:05 ` [PATCH v4 0/5] manual: Header & Standards Cleanup Zack Weinberg
2017-05-22 9:03 ` Rical Jasan
2017-05-24 13:12 ` Rical Jasan
2017-05-24 13:29 ` Zack Weinberg
2017-05-26 5:01 ` [PATCH v5 0/3] " Rical Jasan
2017-05-26 5:01 ` [PATCH v5 0/3] manual: Header & Standards Cleanup [conversion script] Rical Jasan
2017-05-26 5:01 ` [PATCH v5 1/3] manual: Create empty placeholder macros for @standards Rical Jasan
2017-05-26 5:01 ` [PATCH v5 3/3] manual: Replace summary.awk with summary.pl Rical Jasan
2017-05-26 5:01 ` [PATCH v5 2/3] manual: Convert header and standards @comments to @standards Rical Jasan
2017-05-31 9:23 ` [PATCH v5 0/3] manual: Header & Standards Cleanup Rical Jasan
2017-06-08 11:46 ` [PING] " Rical Jasan
2017-06-08 13:41 ` Zack Weinberg
2017-06-09 2:31 ` Rical Jasan
2017-06-15 8:47 ` Rical Jasan
2017-06-15 8:32 ` Rical Jasan
2017-06-15 18:01 ` Joseph Myers
2017-06-16 4:38 ` Rical Jasan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8c0dcc1290c7f685de0af20655223702ace586b7.1494920105.git.ricaljasan@pacific.net \
--to=ricaljasan@pacific.net \
--cc=carlos@redhat.com \
--cc=joseph@codesourcery.com \
--cc=libc-alpha@sourceware.org \
--cc=mtk.manpages@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).