From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 58095 invoked by alias); 16 May 2017 09:55:12 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Received: (qmail 57880 invoked by uid 89); 16 May 2017 09:55:10 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-24.6 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,RP_MATCHES_RCVD,SPF_PASS autolearn=ham version=3.3.2 spammy=hurd, exceptional, encrypt, !!! X-HELO: smtp.pacific.net From: Rical Jasan To: libc-alpha@sourceware.org Cc: Joseph Myers , Carlos O'Donell , Michael Kerrisk Subject: [PATCH v3 3/7] manual: Fix up invalid header and standards syntax. Date: Tue, 16 May 2017 09:55:00 -0000 Message-Id: <8c0dcc1290c7f685de0af20655223702ace586b7.1494920105.git.ricaljasan@pacific.net> In-Reply-To: References: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="------------2.12.2" X-SW-Source: 2017-05/txt/msg00470.txt.bz2 This is a multi-part message in MIME format. --------------2.12.2 Content-Type: text/plain; charset=UTF-8; format=fixed Content-Transfer-Encoding: 8bit Content-length: 773 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(-) --------------2.12.2 Content-Type: text/x-patch; name="0003-manual-Fix-up-invalid-header-and-standards-syntax.patch" Content-Transfer-Encoding: 8bit Content-Disposition: inline; filename="0003-manual-Fix-up-invalid-header-and-standards-syntax.patch" Content-length: 5381 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{}} --------------2.12.2--