From d08a7e4cbe43d5e4e4b14dea950fea623d96c1a1 Mon Sep 17 00:00:00 2001 From: Rical Jasan Date: Thu, 15 Jun 2017 21:12:39 -0700 Subject: manual: Replace summary.awk with summary.pl. The Summary is now generated from @standards, and syntax-checking is performed. If invalid @standards syntax is detected, summary.pl will fail, reporting all errors. Failure and error reporting is disabled for now, however, since much of the manual is still incomplete wrt. header and standards annotations. Note that the sorting order of the Summary has changed; summary.pl respects the locale, like summary.awk did, but the use of LC_ALL=C is introduced in the Makefile. Other notable deviations are improved detection of the annotated elements' names, which are used for sorting, and improved detection of the @node used to reference into the manual. The most noticeable difference in the rendered Summary is that entries may now contain multiple lines, one for each header and standard combination. summary.pl accepts a `--help' option, which details the expected syntax of @standards. If errors are reported, the user is directed to this feature for further information. * manual/Makefile: Generate summary.texi with summary.pl. Force use of the C locale. Update Perl dependency comment. * manual/header.texi: Update reference to summary.awk. * manual/macros.texi: Refer authors to `summary.pl --help'. * manual/summary.awk: Remove file. * manual/summary.pl: New file. Generate summary.texi, and check for @standards-related syntax errors. * manual/argp.texi: Convert header and standards @comments to @standards. * manual/arith.texi: Likewise. * manual/charset.texi: Likewise. * manual/conf.texi: Likewise. * manual/creature.texi: Likewise. * manual/crypt.texi: Likewise. * manual/ctype.texi: Likewise. * manual/debug.texi: Likewise. * manual/errno.texi: Likewise. * manual/filesys.texi: Likewise. * manual/getopt.texi: Likewise. * manual/job.texi: Likewise. * manual/lang.texi: Likewise. * manual/llio.texi: Likewise. * manual/locale.texi: Likewise. * manual/math.texi: Likewise. * manual/memory.texi: Likewise. * manual/message.texi: Likewise. * manual/pattern.texi: Likewise. * manual/pipe.texi: Likewise. * manual/process.texi: Likewise. * manual/resource.texi: Likewise. * manual/search.texi: Likewise. * manual/setjmp.texi: Likewise. * manual/signal.texi: Likewise. * manual/socket.texi: Likewise. * manual/startup.texi: Likewise. * manual/stdio.texi: Likewise. * manual/string.texi: Likewise. * manual/sysinfo.texi: Likewise. * manual/syslog.texi: Likewise. * manual/terminal.texi: Likewise. * manual/threads.texi: Likewise. * manual/time.texi: Likewise. * manual/users.texi: Likewise. --- manual/job.texi | 33 +++++++++++---------------------- 1 file changed, 11 insertions(+), 22 deletions(-) (limited to 'manual/job.texi') diff --git a/manual/job.texi b/manual/job.texi index 72b55997d2..944967a73d 100644 --- a/manual/job.texi +++ b/manual/job.texi @@ -1036,9 +1036,8 @@ The function @code{ctermid} is declared in the header file @file{stdio.h}. @pindex stdio.h -@comment stdio.h -@comment POSIX.1 @deftypefun {char *} ctermid (char *@var{string}) +@standards{POSIX.1, stdio.h} @safety{@prelim{}@mtsafe{@mtsposix{/!string}}@assafe{}@acsafe{}} @c This function is a stub by default; the actual implementation, for @c posix systems, returns a pointer to a string literal if passed a NULL @@ -1057,9 +1056,8 @@ any reason. Even if a file name is returned, access to the file it represents is not guaranteed. @end deftypefun -@comment stdio.h -@comment POSIX.1 @deftypevr Macro int L_ctermid +@standards{POSIX.1, stdio.h} The value of this macro is an integer constant expression that represents the size of a string large enough to hold the file name returned by @code{ctermid}. @@ -1078,9 +1076,8 @@ Your program should include the header files @file{sys/types.h} and @pindex unistd.h @pindex sys/types.h -@comment unistd.h -@comment POSIX.1 @deftypefun pid_t setsid (void) +@standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c This is usually a direct syscall, but if a syscall is not available, @c we use a stub, or Hurd- and BSD-specific implementations. The former @@ -1107,9 +1104,8 @@ already another process group around that has the same process group ID. @end table @end deftypefun -@comment unistd.h -@comment SVID @deftypefun pid_t getsid (pid_t @var{pid}) +@standards{SVID, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Stub or direct syscall, except on hurd, where it is equally safe. @@ -1132,17 +1128,15 @@ from the calling process. @end table @end deftypefun -@comment unistd.h -@comment POSIX.1 @deftypefun pid_t getpgrp (void) +@standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} The @code{getpgrp} function returns the process group ID of the calling process. @end deftypefun -@comment unistd.h -@comment POSIX.1 @deftypefun int getpgid (pid_t @var{pid}) +@standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Stub or direct syscall, except on hurd, where it is equally safe. @@ -1164,9 +1158,8 @@ process. @end table @end deftypefun -@comment unistd.h -@comment POSIX.1 @deftypefun int setpgid (pid_t @var{pid}, pid_t @var{pgid}) +@standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Stub or direct syscall, except on hurd, where it is equally safe. The @code{setpgid} function puts the process @var{pid} into the process @@ -1203,9 +1196,8 @@ process or a child of the calling process. @end table @end deftypefun -@comment unistd.h -@comment BSD @deftypefun int setpgrp (pid_t @var{pid}, pid_t @var{pgid}) +@standards{BSD, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Direct syscall or setpgid wrapper. This is the BSD Unix name for @code{setpgid}. Both functions do exactly @@ -1227,9 +1219,8 @@ Although these functions take a file descriptor argument to specify the terminal device, the foreground job is associated with the terminal file itself and not a particular open file descriptor. -@comment unistd.h -@comment POSIX.1 @deftypefun pid_t tcgetpgrp (int @var{filedes}) +@standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Stub, or ioctl on BSD and GNU/Linux. This function returns the process group ID of the foreground process @@ -1257,9 +1248,8 @@ controlling terminal of the calling process. @end table @end deftypefun -@comment unistd.h -@comment POSIX.1 @deftypefun int tcsetpgrp (int @var{filedes}, pid_t @var{pgid}) +@standards{POSIX.1, unistd.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Stub, or ioctl on BSD and GNU/Linux. This function is used to set a terminal's foreground process group ID. @@ -1298,9 +1288,8 @@ process. @end table @end deftypefun -@comment termios.h -@comment Unix98 @deftypefun pid_t tcgetsid (int @var{fildes}) +@standards{Unix98, termios.h} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @c Ioctl call, if available, or tcgetpgrp followed by getsid. This function is used to obtain the process group ID of the session -- cgit 1.4.1