From: Eli Zaretskii <eliz@gnu.org>
To: Aaron Merey <amerey@redhat.com>
Cc: gdb-patches@sourceware.org, simark@simark.ca
Subject: Re: [PATCH 2/2] gdb.texinfo: Expand documentation for debuginfod
Date: Tue, 19 Oct 2021 14:17:20 +0300 [thread overview]
Message-ID: <83tuhdclhb.fsf@gnu.org> (raw)
In-Reply-To: <20211018230133.265619-3-amerey@redhat.com> (message from Aaron Merey via Gdb-patches on Mon, 18 Oct 2021 19:01:33 -0400)
> 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.
next prev parent reply other threads:[~2021-10-19 11:17 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-18 23:01 [PATCH 0/2 v3] gdb: Add debuginfod first-use notification Aaron Merey
2021-10-18 23:01 ` [PATCH 1/2] gdb: add set/show commands for managing debuginfod Aaron Merey
2021-10-20 20:34 ` Keith Seitz
2021-10-21 22:23 ` Lancelot SIX
2021-10-25 22:30 ` Aaron Merey
2021-10-21 22:02 ` Lancelot SIX
2021-10-26 16:08 ` Simon Marchi
2021-10-28 22:18 ` Aaron Merey
2021-10-29 1:47 ` Simon Marchi
2021-10-30 1:09 ` Aaron Merey
2021-10-30 1:54 ` Simon Marchi
2021-10-31 2:43 ` Simon Marchi
2021-11-01 15:52 ` Simon Marchi
2021-11-01 17:39 ` Aaron Merey
2021-11-01 18:00 ` Simon Marchi
2021-11-02 16:51 ` Simon Marchi
2021-11-02 20:35 ` Aaron Merey
2021-10-18 23:01 ` [PATCH 2/2] gdb.texinfo: Expand documentation for debuginfod Aaron Merey
2021-10-19 11:17 ` Eli Zaretskii [this message]
2021-10-19 22:35 ` Aaron Merey
2021-10-20 11:38 ` Eli Zaretskii
2021-10-30 1:18 ` Aaron Merey
2021-10-30 6:57 ` Tom de Vries
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83tuhdclhb.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=amerey@redhat.com \
--cc=gdb-patches@sourceware.org \
--cc=simark@simark.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).