manual: Fix up invalid header and standards syntax.

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.
This commit is contained in:
Rical Jasan 2017-05-14 03:58:32 -07:00
parent dec4a7105e
commit f227c3e0a6
7 changed files with 23 additions and 13 deletions

View File

@ -1,3 +1,15 @@
2017-05-18 Rical Jasan <ricaljasan@pacific.net>
* 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.
2017-05-18 Rajalakshmi Srinivasaraghavan <raji@linux.vnet.ibm.com> 2017-05-18 Rajalakshmi Srinivasaraghavan <raji@linux.vnet.ibm.com>
* sysdeps/powerpc/powerpc64/multiarch/Makefile * sysdeps/powerpc/powerpc64/multiarch/Makefile

View File

@ -290,10 +290,10 @@ stored in a @code{char}, but there are no parity bits in @var{block}.
@comment crypt.h @comment crypt.h
@comment GNU @comment GNU
@deftypefun void setkey_r (const char *@var{key}, {struct crypt_data *} @var{data}) @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 crypt.h
@comment GNU @comment GNU
@deftypefunx void encrypt_r (char *@var{block}, int @var{edflag}, {struct crypt_data *} @var{data}) @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{}}} @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{} @asulock{}}@acunsafe{@aculock{}}}
These are reentrant versions of @code{setkey} and @code{encrypt}. The These are reentrant versions of @code{setkey} and @code{encrypt}. The

View File

@ -716,7 +716,7 @@ entries in a directory, possibly sort them and get a list of names as
the result. the result.
@comment dirent.h @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 **)) @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{}}} @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{} @acsfd{}}}
@c The scandir function calls __opendirat, __readdir, and __closedir to @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. are very helpful for this purpose.
@comment dirent.h @comment dirent.h
@comment BSD/SVID @comment BSD, SVID
@deftypefun int alphasort (const struct dirent **@var{a}, const struct dirent **@var{b}) @deftypefun int alphasort (const struct dirent **@var{a}, const struct dirent **@var{b})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}} @safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
@c Calls strcoll. @c Calls strcoll.
@ -1315,8 +1315,8 @@ The directory or file system cannot be extended to make the new link.
@item EIO @item EIO
A hardware error occurred while reading or writing data on the disk. A hardware error occurred while reading or writing data on the disk.
@ignore
@comment not sure about these @comment not sure about these
@ignore
@item ELOOP @item ELOOP
There are too many levels of indirection. This can be the result of There are too many levels of indirection. This can be the result of
circular symbolic links to directories. circular symbolic links to directories.
@ -3543,9 +3543,9 @@ opening the file you should use the @code{O_EXCL} flag. Using
@end deftypefun @end deftypefun
@cindex TMPDIR environment variable @cindex TMPDIR environment variable
@c !!! are we putting SVID/GNU/POSIX.1/BSD in here or not??
@comment stdio.h @comment stdio.h
@comment SVID @comment SVID
@c !!! are we putting SVID/GNU/POSIX.1/BSD in here or not??
@deftypevr {SVID Macro} {char *} P_tmpdir @deftypevr {SVID Macro} {char *} P_tmpdir
This macro is the name of the default directory for temporary files. This macro is the name of the default directory for temporary files.
@end deftypevr @end deftypevr

View File

@ -1406,8 +1406,8 @@ English.
@Theglibc{} contains @code{rpmatch} to give applications easy @Theglibc{} contains @code{rpmatch} to give applications easy
access to the corresponding locale definitions. access to the corresponding locale definitions.
@comment GNU
@comment stdlib.h @comment stdlib.h
@comment GNU
@deftypefun int rpmatch (const char *@var{response}) @deftypefun int rpmatch (const char *@var{response})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@asucorrupt{} @ascuheap{} @asulock{} @ascudlopen{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}} @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 @c Calls nl_langinfo with YESEXPR and NOEXPR, triggering @mtslocale but

View File

@ -1161,7 +1161,7 @@ The highest valid nice value.
@end vtable @end vtable
@comment sys/resource.h @comment sys/resource.h
@comment BSD,POSIX @comment BSD, POSIX
@deftypefun int getpriority (int @var{class}, int @var{id}) @deftypefun int getpriority (int @var{class}, int @var{id})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Direct syscall on UNIX. On HURD, calls _hurd_priority_which_map. @c Direct syscall on UNIX. On HURD, calls _hurd_priority_which_map.
@ -1190,7 +1190,7 @@ afterward as the criterion for failure.
@end deftypefun @end deftypefun
@comment sys/resource.h @comment sys/resource.h
@comment BSD,POSIX @comment BSD, POSIX
@deftypefun int setpriority (int @var{class}, int @var{id}, int @var{niceval}) @deftypefun int setpriority (int @var{class}, int @var{id}, int @var{niceval})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Direct syscall on UNIX. On HURD, calls _hurd_priority_which_map. @c Direct syscall on UNIX. On HURD, calls _hurd_priority_which_map.

View File

@ -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}. The return value and error conditions are the same as for @code{setitimer}.
@end deftypefun @end deftypefun
@vtable @code
@comment sys/time.h @comment sys/time.h
@comment BSD @comment BSD
@vtable @code
@item ITIMER_REAL @item ITIMER_REAL
This constant can be used as the @var{which} argument to the This constant can be used as the @var{which} argument to the
@code{setitimer} and @code{getitimer} functions to specify the real-time @code{setitimer} and @code{getitimer} functions to specify the real-time

View File

@ -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 these functions are merely copies, since the two structures are
identical. identical.
@comment utmpx.h @comment utmp.h utmpx.h
@comment utmp.h
@comment GNU @comment GNU
@deftypefun int getutmp (const struct utmpx *@var{utmpx}, struct utmp *@var{utmp}) @deftypefun int getutmp (const struct utmpx *@var{utmpx}, struct utmp *@var{utmp})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@ -1664,8 +1663,7 @@ identical.
compatible, from @var{utmpx} to @var{utmp}. compatible, from @var{utmpx} to @var{utmp}.
@end deftypefun @end deftypefun
@comment utmpx.h @comment utmp.h utmpx.h
@comment utmp.h
@comment GNU @comment GNU
@deftypefun int getutmpx (const struct utmp *@var{utmp}, struct utmpx *@var{utmpx}) @deftypefun int getutmpx (const struct utmp *@var{utmp}, struct utmpx *@var{utmpx})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}