From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from eggs.gnu.org (eggs.gnu.org [IPv6:2001:470:142:3::10]) by sourceware.org (Postfix) with ESMTPS id F083D3858D3C for ; Tue, 19 Oct 2021 11:17:12 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org F083D3858D3C Received: from fencepost.gnu.org ([2001:470:142:3::e]:49474) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mcn7I-0004xR-Fu; Tue, 19 Oct 2021 07:17:12 -0400 Received: from [87.69.77.57] (port=4919 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mcn7H-00032O-Cd; Tue, 19 Oct 2021 07:17:12 -0400 Date: Tue, 19 Oct 2021 14:17:20 +0300 Message-Id: <83tuhdclhb.fsf@gnu.org> From: Eli Zaretskii To: Aaron Merey Cc: gdb-patches@sourceware.org, simark@simark.ca 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) Subject: Re: [PATCH 2/2] gdb.texinfo: Expand documentation for debuginfod References: <20211018230133.265619-1-amerey@redhat.com> <20211018230133.265619-3-amerey@redhat.com> X-Spam-Status: No, score=2.0 required=5.0 tests=BAYES_00, KAM_DMARC_STATUS, RCVD_IN_BARRACUDACENTRAL, SPF_HELO_PASS, SPF_PASS, TXREP autolearn=no autolearn_force=no version=3.4.4 X-Spam-Level: ** X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Oct 2021 11:17:14 -0000 > Date: Mon, 18 Oct 2021 19:01:33 -0400 > From: Aaron Merey via Gdb-patches > 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.