Re: gcc/libiberty ChangeLog Makefile.in alloca.c a ...

["Joseph S. Myers" <jsm28 at cam dot ac dot uk>]

On Tue, 16 Oct 2001, DJ Delorie wrote:

> ! Returns a pointer to the argument vector if successful. Returns

Two spaces after full stops in Texinfo.

> ! Returns a pointer to the argument vector if successful. Returns

Likewise.

> + @deftypefn Extension int asprintf (char **@var{resptr}, char *@var{format}, ...)

format is const char *.

> ! @deftypefn Extension char* concat (char *@var{s1}, char *@var{s2}, ..., @code{NULL})

The strings are const char *.  I think that ... should be @dots{} since it 
is representing an ellipsis rather than a literal ... C token.

> ! xmalloc'd memory.  Returns @code{NULL} if insufficient memory is

Later you use "malloced".  The spelling/formatting should be consistent; I 
suggest "@code{xmalloc}ed" / "@code{malloc}ed".

> + @deftypefn Extension char* reconcat (char *@var{optr}, char *@var{s1}, ..., @code{NULL})

Same comments about const and dots.

> ! Find the first (least significant) bit set in @var{valu}. Bits are

Two spaces after full stop.

> + @deftypefn Replacement long get_run_time ()

(void) in prototype.

> + @deftypefn Replacement char* choose_tmpdir ()

(void) in prototype.

> + string is malloced, and the temporary file has been created.

Inconsistency with "xmalloc'd", noted above.

> + @example
>      <path>/ccXXXXXX<suffix>

@var{path}, @var{suffix}.

> + @var{suffix_len} tells us how long <suffix> is (it can be zero
> + length).  The last six characters of @var{template} before <suffix>

@var{suffix}

> + must be @code{XXXXXX}; they are replaced with a string that makes the

@samp{XXXXXX} (since XXXXXX is part of a string rather than made up of 
whole programming language tokens).

> + @var{this_pname} is name of the calling program (i.e. @code{argv[0]}).

Comma after "i.e.".

> + (@var{flags} & @code{PEXECUTE_SEARCH}) is non-zero if @code{$PATH} should be searched

@code{(@var{flags} & PEXECUTE_SEARCH)}, since it's a programming language 
expression as a whole (and would look odd in Info otherwise - Info adds `' 
around @code and @samp though the printed output only adds them about 
@samp).  @env{PATH}.

> + (??? It's not clear that GCC passes this flag correctly). (@var{flags} &
> + @code{PEXECUTE_FIRST}) is nonzero for the first process in chain.

Same comment.  Two spaces after full stops.

> + (@var{flags} & @code{PEXECUTE_FIRST}) is nonzero for the last process

Same comment.

> + The result is the WEXITSTATUS on systems like MS-DOS where we

@code{WEXITSTATUS}.

> + text of the error message with an optional argument (if not needed,
> + @var{errmsg_arg} is set to @code{NULL}), and -1 is returned.

@minus{}1.

> + 
> + @var{pid} is the process id of the task to wait for. @var{status} is

Two spaces after full stops.

> + The result is the pid of the child reaped, or -1 for failure

@minus{}1.

> + @deftypefn Supplement {long int} random ()

(void) in prototype.

> + Random number functions.  @code{random} returns a random number in the
> + range @code{0..LONG_MAX}.  @code{srandom} initializes the random

This range isn't a programming language expression - try
"0--@code{LONG_MAX}" or "0 to @code{LONG_MAX}".

> + run of the program).  @code{initstate} and @code{setstate} allow fine-grain

"fine-grained" rather than "fine-grain", I think.

> ! @deftypefn Extension int signo_max ()

(void) in prototype.

> + @deftypefn Extension int vasprintf (char **@var{resptr}, char *@var{format}, va_list @var{args})

const.

> boolean OR of zero or more of the following values (defined in
> @code{<fnmatch.h>}:

Missing close parenthesis.

-- 
Joseph S. Myers
jsm28@cam.ac.uk