Fix various problems with @deftypefun lines.

This commit is contained in:
Nicolas Boulenguez 2012-02-17 17:44:38 +00:00 committed by Joseph Myers
parent 6dd8f3dca0
commit cc6e48bc7c
16 changed files with 84 additions and 38 deletions

View File

@ -1,3 +1,48 @@
2012-02-17 Nicolas Boulenguez <nicolas.boulenguez@free.fr>
[BZ #5805]
* manual/arith.texi (scalbn): Use @var{} on parameter names.
(scalbnf): Likewise.
(scalbnl): Likewise.
(scalbln): Likewise.
(scalblnf): Likewise.
(scalblnl): Likewise.
* manual/errno.texi (vwarn): Name last parameter as @var{ap}.
(vwarnx): Likewise.
(verr): Likewise.
(verrx): Likewise.
* manual/filesys.texi (telldir): Use braces around return type.
* manual/llio.texi (mmap): Add space after comma.
(mmap64): Likewise.
* manual/math.texi (jn): Use @var{} on parameter names.
(jnf): Likewise.
(jnl): Likewise.
(yn): Likewise.
(ynf): Likewise.
(ynl): Likewise.
* manual/memory.texi (alloca): Remove semicolon on @deftypefun
line.
* manual/resource.texi (ulimit): Use @dots{} instead of literal
"...".
(sched_get_priority_min): Remove semicolon on @deftypefun line.
(sched_get_priority_max): Likewise.
* manual/signal.texi (sigvec): Add space after comma.
* manual/socket.texi (if_nametoindex): Use @var{} on parameter
names.
(if_indextoname): Likewise.
(if_freenameindex): Likewise.
(sendto): Use ',' instead of '.' in prototype.
* manual/startup.texi (syscall): Use @dots{} instead of literal
"...".
* manual/stdio.texi (__fpending): Separate initial words of
paragraph from @deftypefun line.
* manual/syslog.texi (syslog): Use @dots{} instead of literal
"...".
(vsyslog): Use @var{} on parameter names.
* manual/terminal.texi (stty): Use @var{} on parameter names.
* manual/users.texi (getutmp): Use @var{} on parameter names.
(getutmpx): Likewise.
2012-02-17 Joseph Myers <joseph@codesourcery.com>
[BZ #6884]

6
NEWS
View File

@ -9,9 +9,9 @@ Version 2.16
* The following bugs are resolved with this release:
350, 411, 3335, 4026, 4822, 6884, 9902, 10140, 11494, 13525, 13526, 13527,
13528, 13529, 13531, 13532, 13533, 13547, 13530, 13551, 13552, 13553,
13555, 13559, 13583, 13618
350, 411, 3335, 4026, 4822, 5805, 6884, 9902, 10140, 11494, 13525, 13526,
13527, 13528, 13529, 13531, 13532, 13533, 13547, 13530, 13551, 13552,
13553, 13555, 13559, 13583, 13618
* ISO C11 support:

View File

@ -1264,26 +1264,26 @@ The @code{scalb} function is the BSD name for @code{ldexp}.
@comment math.h
@comment BSD
@deftypefun {long long int} scalbn (double @var{x}, int n)
@deftypefun {long long int} scalbn (double @var{x}, int @var{n})
@comment math.h
@comment BSD
@deftypefunx {long long int} scalbnf (float @var{x}, int n)
@deftypefunx {long long int} scalbnf (float @var{x}, int @var{n})
@comment math.h
@comment BSD
@deftypefunx {long long int} scalbnl (long double @var{x}, int n)
@deftypefunx {long long int} scalbnl (long double @var{x}, int @var{n})
@code{scalbn} is identical to @code{scalb}, except that the exponent
@var{n} is an @code{int} instead of a floating-point number.
@end deftypefun
@comment math.h
@comment BSD
@deftypefun {long long int} scalbln (double @var{x}, long int n)
@deftypefun {long long int} scalbln (double @var{x}, long int @var{n})
@comment math.h
@comment BSD
@deftypefunx {long long int} scalblnf (float @var{x}, long int n)
@deftypefunx {long long int} scalblnf (float @var{x}, long int @var{n})
@comment math.h
@comment BSD
@deftypefunx {long long int} scalblnl (long double @var{x}, long int n)
@deftypefunx {long long int} scalblnl (long double @var{x}, long int @var{n})
@code{scalbln} is identical to @code{scalb}, except that the exponent
@var{n} is a @code{long int} instead of a floating-point number.
@end deftypefun

View File

@ -1585,7 +1585,7 @@ are not used.
@comment err.h
@comment BSD
@deftypefun void vwarn (const char *@var{format}, va_list)
@deftypefun void vwarn (const char *@var{format}, va_list @var{ap})
The @code{vwarn} function is just like @code{warn} except that the
parameters for the handling of the format string @var{format} are passed
in as an value of type @code{va_list}.
@ -1606,7 +1606,7 @@ string is printed.
@comment err.h
@comment BSD
@deftypefun void vwarnx (const char *@var{format}, va_list)
@deftypefun void vwarnx (const char *@var{format}, va_list @var{ap})
The @code{vwarnx} function is just like @code{warnx} except that the
parameters for the handling of the format string @var{format} are passed
in as an value of type @code{va_list}.
@ -1626,7 +1626,7 @@ are not used and that the program is exited even if @var{status} is zero.
@comment err.h
@comment BSD
@deftypefun void verr (int @var{status}, const char *@var{format}, va_list)
@deftypefun void verr (int @var{status}, const char *@var{format}, va_list @var{ap})
The @code{verr} function is just like @code{err} except that the
parameters for the handling of the format string @var{format} are passed
in as an value of type @code{va_list}.
@ -1648,7 +1648,7 @@ string is printed.
@comment err.h
@comment BSD
@deftypefun void verrx (int @var{status}, const char *@var{format}, va_list)
@deftypefun void verrx (int @var{status}, const char *@var{format}, va_list @var{ap})
The @code{verrx} function is just like @code{errx} except that the
parameters for the handling of the format string @var{format} are passed
in as an value of type @code{va_list}.

View File

@ -582,7 +582,7 @@ added or removed since you last called @code{opendir} or
@comment dirent.h
@comment BSD
@deftypefun long int telldir (DIR *@var{dirstream})
@deftypefun {long int} telldir (DIR *@var{dirstream})
The @code{telldir} function returns the file position of the directory
stream @var{dirstream}. You can use this value with @code{seekdir} to
restore the directory stream to that position.

View File

@ -1161,7 +1161,7 @@ These functions are declared in @file{sys/mman.h}.
@comment sys/mman.h
@comment POSIX
@deftypefun {void *} mmap (void *@var{address}, size_t @var{length},int @var{protect}, int @var{flags}, int @var{filedes}, off_t @var{offset})
@deftypefun {void *} mmap (void *@var{address}, size_t @var{length}, int @var{protect}, int @var{flags}, int @var{filedes}, off_t @var{offset})
The @code{mmap} function creates a new mapping, connected to bytes
(@var{offset}) to (@var{offset} + @var{length} - 1) in the file open on
@ -1280,7 +1280,7 @@ The file is on a filesystem that doesn't support mapping.
@comment sys/mman.h
@comment LFS
@deftypefun {void *} mmap64 (void *@var{address}, size_t @var{length},int @var{protect}, int @var{flags}, int @var{filedes}, off64_t @var{offset})
@deftypefun {void *} mmap64 (void *@var{address}, size_t @var{length}, int @var{protect}, int @var{flags}, int @var{filedes}, off64_t @var{offset})
The @code{mmap64} function is equivalent to the @code{mmap} function but
the @var{offset} parameter is of type @code{off64_t}. On 32-bit systems
this allows the file associated with the @var{filedes} descriptor to be

View File

@ -1148,13 +1148,13 @@ This function was introduced in @w{ISO C99}.
@comment math.h
@comment SVID
@deftypefun double jn (int n, double @var{x})
@deftypefun double jn (int @var{n}, double @var{x})
@comment math.h
@comment SVID
@deftypefunx float jnf (int n, float @var{x})
@deftypefunx float jnf (int @var{n}, float @var{x})
@comment math.h
@comment SVID
@deftypefunx {long double} jnl (int n, long double @var{x})
@deftypefunx {long double} jnl (int @var{n}, long double @var{x})
@code{jn} returns the Bessel function of the first kind of order
@var{n} of @var{x}. It may signal underflow if @var{x} is too large.
@end deftypefun
@ -1191,13 +1191,13 @@ is negative, @code{y1} signals a domain error; if it is zero,
@comment math.h
@comment SVID
@deftypefun double yn (int n, double @var{x})
@deftypefun double yn (int @var{n}, double @var{x})
@comment math.h
@comment SVID
@deftypefunx float ynf (int n, float @var{x})
@deftypefunx float ynf (int @var{n}, float @var{x})
@comment math.h
@comment SVID
@deftypefunx {long double} ynl (int n, long double @var{x})
@deftypefunx {long double} ynl (int @var{n}, long double @var{x})
@code{yn} returns the Bessel function of the second kind of order @var{n} of
@var{x}. It may signal underflow if @var{x} is too large. If @var{x}
is negative, @code{yn} signals a domain error; if it is zero,

View File

@ -2168,7 +2168,7 @@ a BSD extension.
@comment stdlib.h
@comment GNU, BSD
@deftypefun {void *} alloca (size_t @var{size});
@deftypefun {void *} alloca (size_t @var{size})
The return value of @code{alloca} is the address of a block of @var{size}
bytes of memory, allocated in the stack frame of the calling function.
@end deftypefun

View File

@ -436,7 +436,7 @@ above do. The functions above are better choices.
@comment ulimit.h
@comment BSD
@deftypefun int ulimit (int @var{cmd}, ...)
@deftypefun int ulimit (int @var{cmd}, @dots{})
@code{ulimit} gets the current limit or sets the current and maximum
limit for a particular resource for the calling process according to the
@ -925,7 +925,7 @@ There is no process with pid @var{pid} and it is not zero.
@comment sched.h
@comment POSIX
@deftypefun int sched_get_priority_min (int *@var{policy});
@deftypefun int sched_get_priority_min (int *@var{policy})
This function returns the lowest absolute priority value that is
allowable for a process with scheduling policy @var{policy}.
@ -945,7 +945,7 @@ to this function are:
@comment sched.h
@comment POSIX
@deftypefun int sched_get_priority_max (int *@var{policy});
@deftypefun int sched_get_priority_max (int *@var{policy})
This function returns the highest absolute priority value that is
allowable for a process that with scheduling policy @var{policy}.

View File

@ -3300,7 +3300,7 @@ structure, it means to reset the action for the signal back to
@comment signal.h
@comment BSD
@deftypefun int sigvec (int @var{signum}, const struct sigvec *@var{action},struct sigvec *@var{old-action})
@deftypefun int sigvec (int @var{signum}, const struct sigvec *@var{action}, struct sigvec *@var{old-action})
This function is the equivalent of @code{sigaction} (@pxref{Advanced Signal
Handling}); it installs the action @var{action} for the signal @var{signum},
returning information about the previous action in effect for that signal

View File

@ -500,14 +500,14 @@ interface name, including its terminating zero byte.
@comment net/if.h
@comment IPv6 basic API
@deftypefun {unsigned int} if_nametoindex (const char *ifname)
@deftypefun {unsigned int} if_nametoindex (const char *@var{ifname})
This function yields the interface index corresponding to a particular
name. If no interface exists with the name given, it returns 0.
@end deftypefun
@comment net/if.h
@comment IPv6 basic API
@deftypefun {char *} if_indextoname (unsigned int ifindex, char *ifname)
@deftypefun {char *} if_indextoname (unsigned int @var{ifindex}, char *@var{ifname})
This function maps an interface index to its corresponding name. The
returned name is placed in the buffer pointed to by @code{ifname}, which
must be at least @code{IFNAMSIZ} bytes in length. If the index was
@ -545,7 +545,7 @@ use.
@comment net/if.h
@comment IPv6 basic API
@deftypefun void if_freenameindex (struct if_nameindex *ptr)
@deftypefun void if_freenameindex (struct if_nameindex *@var{ptr})
This function frees the structure returned by an earlier call to
@code{if_nameindex}.
@end deftypefun
@ -2643,7 +2643,7 @@ more information about the @code{connect} function.
@comment sys/socket.h
@comment BSD
@deftypefun int sendto (int @var{socket}, void *@var{buffer}. size_t @var{size}, int @var{flags}, struct sockaddr *@var{addr}, socklen_t @var{length})
@deftypefun int sendto (int @var{socket}, void *@var{buffer}, size_t @var{size}, int @var{flags}, struct sockaddr *@var{addr}, socklen_t @var{length})
The @code{sendto} function transmits the data in the @var{buffer}
through the socket @var{socket} to the destination address specified
by the @var{addr} and @var{length} arguments. The @var{size} argument

View File

@ -625,7 +625,7 @@ anyway.
@comment unistd.h
@comment ???
@deftypefun {long int} syscall (long int @var{sysno}, ...)
@deftypefun {long int} syscall (long int @var{sysno}, @dots{})
@code{syscall} performs a generic system call.

View File

@ -4750,7 +4750,8 @@ This function is declared in the @file{stdio_ext.h} header.
@comment stdio_ext.h
@comment GNU
@deftypefun size_t __fpending (FILE *@var{stream}) The @code{__fpending}
@deftypefun size_t __fpending (FILE *@var{stream})
The @code{__fpending}
function returns the number of bytes currently in the output buffer.
For wide-oriented stream the measuring unit is wide characters. This
function should not be used on buffers in read mode or opened read-only.

View File

@ -275,7 +275,7 @@ The symbols referred to in this section are declared in the file
@c syslog() is implemented as a call to vsyslog().
@comment syslog.h
@comment BSD
@deftypefun void syslog (int @var{facility_priority}, char *@var{format}, ...)
@deftypefun void syslog (int @var{facility_priority}, char *@var{format}, @dots{})
@code{syslog} submits a message to the Syslog facility. It does this by
writing to the Unix domain socket @code{/dev/log}.
@ -403,7 +403,7 @@ syslog (LOG_MAKEPRI(LOG_LOCAL1, LOG_ERROR),
@comment syslog.h
@comment BSD
@deftypefun void vsyslog (int @var{facility_priority}, char *@var{format}, va_list arglist)
@deftypefun void vsyslog (int @var{facility_priority}, char *@var{format}, va_list @var{arglist})
This is functionally identical to @code{syslog}, with the BSD style variable
length argument.

View File

@ -1679,7 +1679,7 @@ of the terminal which is open with file descriptor @var{filedes}.
@comment sgtty.h
@comment BSD
@deftypefun int stty (int @var{filedes}, struct sgttyb * attributes)
@deftypefun int stty (int @var{filedes}, struct sgttyb *@var{attributes})
This function sets the attributes of a terminal.

View File

@ -1390,7 +1390,7 @@ identical.
@comment utmpx.h
@comment utmp.h
@comment GNU
@deftypefun int getutmp (const struct utmpx *utmpx, struct utmp *utmp)
@deftypefun int getutmp (const struct utmpx *@var{utmpx}, struct utmp *@var{utmp})
@code{getutmp} copies the information, insofar as the structures are
compatible, from @var{utmpx} to @var{utmp}.
@end deftypefun
@ -1398,7 +1398,7 @@ compatible, from @var{utmpx} to @var{utmp}.
@comment utmpx.h
@comment utmp.h
@comment GNU
@deftypefun int getutmpx (const struct utmp *utmp, struct utmpx *utmpx)
@deftypefun int getutmpx (const struct utmp *@var{utmp}, struct utmpx *@var{utmpx})
@code{getutmpx} copies the information, insofar as the structures are
compatible, from @var{utmp} to @var{utmpx}.
@end deftypefun