[PATCH 2/2] gdb.texinfo: Expand documentation for debuginfod

Eli Zaretskii eliz@gnu.org
Tue Oct 19 11:17:20 GMT 2021


> Date: Mon, 18 Oct 2021 19:01:33 -0400
> From: Aaron Merey via Gdb-patches <gdb-patches@sourceware.org>
> Cc: simark@simark.ca
> 
> Add section describing GDB's usage of debuginfod and new
> debuginfod commands.

Thanks.

> +With the @code{debuginfod} client library, @file{libdebuginfod}, @value{GDBN}
> +can query servers using the build IDs of missing resources in order to download
> +them on demand.
> +
> +@value{GDBN} is able to automatically download missing debug info and source
> +files using @code{debuginfod}.

It sounds like these two paragraphs say the same, so only one of them
is needed.

> +For instructions on building @value{GDBN} with @file{libdebuginfod},
> +@xref{Configure Options,,--with-debuginfod}.  @code{debuginfod} is packaged

This should be @pxref.  @xref produces a capitalized "See", so it is
only appropriate at the beginning of a sentence.

> +@item set debuginfod
> +@itemx set debuginfod on
> +@cindex enable debuginfod
> +@value{GDBN} will attempt to query @code{debuginfod} servers when missing debug
> +info or source files.
> +
> +@item set debuginfod off
> +@value{GDBN} will not attempt to query @code{debuginfod} servers when missing
> +debug info or source files.
> +
> +@item set debuginfod ask
> +@value{GDBN} will prompt the user to enable or disable @code{debuginfod} before
> +attempting to perform the next query.

Please state which one of these is the default.  This text:

> +By default, @code{debuginfod} is set to @code{ask} for interactive sessions and
> +@code{off} for non-interactive sessions.

should be here, not further down.

> +@kindex set debuginfod-urls
> +@cindex configure debuginfod URLs
> +@item set debuginfod-urls
> +@itemx set debuginfod-urls @var{urls}
> +Set the space-separated list of URLs that @code{debuginfod} will attempt to
> +query.

Should we tell what protocol(s) are supported for these URLs?

Also, please describe the default here, not further down.

> +@code{off} for non-interactive sessions. The default value of
> +@code{debuginfod-urls} is copied from @var{$DEBUGINFOD_URLS}. Debuginfod
> +debugging output is shown by default.

Don't forget to leave 2 spaces between sentences.


More information about the Gdb-patches mailing list