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 489093858CDB for ; Thu, 1 Jun 2023 06:12:52 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 489093858CDB Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=gnu.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gnu.org Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1q4bYJ-0005HU-79; Thu, 01 Jun 2023 02:12:51 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=aClJPcgJCFB+JdILVoe7yZwkBb5UlfAqxh84pmYCzmw=; b=HU6JFx8g+xWw 7R61XNQdSpdJXIWYS3mUfB+pQ0ZES014k7Q/nco+dfzPH0KMUahXjDNml/SIONfNbQmmFBXxHTukD rAS46BUd3Wjx56QWXKAtPJnP0K69OfuAzmBFkrr1dLugqXH2SJGtzfLyb7b1hlNmOkwUBGLIzm0L6 7HHC5yyFiWnObEkMGDlfP3udxhDu0BIrcnGU8Qz8T7UUCtrj3IzEMOQpdtLaum1bSmPfFBFQW6i30 v4XLebN9h93incdPAgCc7IRjdusD/p0H9OvO2lLDFyuNU6XIyRmMttxc1vLX+artPfSZKYGIG7HNA WxmGOHnCX7R1zZg6CguOwA==; Received: from [87.69.77.57] (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 1q4bYI-0002Bk-NX; Thu, 01 Jun 2023 02:12:51 -0400 Date: Thu, 01 Jun 2023 09:13:36 +0300 Message-Id: <83bkhzemlr.fsf@gnu.org> From: Eli Zaretskii To: Aaron Merey Cc: gdb-patches@sourceware.org, aburgess@redhat.com In-Reply-To: <20230601014347.3367489-3-amerey@redhat.com> (message from Aaron Merey via Gdb-patches on Wed, 31 May 2023 21:43:43 -0400) Subject: Re: [PATCH 2/6 v2] gdb: Add command 'maint set/show debuginfod download-sections' References: <20230601014347.3367489-1-amerey@redhat.com> <20230601014347.3367489-3-amerey@redhat.com> X-Spam-Status: No, score=1.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_BARRACUDACENTRAL,SPF_HELO_PASS,SPF_PASS,TXREP,T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6 X-Spam-Level: * X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: > Cc: aburgess@redhat.com, > Aaron Merey > Date: Wed, 31 May 2023 21:43:43 -0400 > From: Aaron Merey via Gdb-patches > > gdb/debuginfod-support.c | 66 ++++++++++++++++++++++++++++++++++++++-- > gdb/doc/gdb.texinfo | 16 ++++++++-- > 2 files changed, 77 insertions(+), 5 deletions(-) Thanks. > @@ -568,8 +604,11 @@ _initialize_debuginfod () > _("Set whether to use debuginfod."), > _("Show whether to use debuginfod."), > _("\ > -When on, enable the use of debuginfod to download missing debug info and\n\ > -source files."), > +When set to \"on\", enable the use of debuginfod to download missing\n\ > +debug info and source files. GDB may also download components of debug\n\ > +info instead of entire files. \"off\" disables the use of debuginfod.\n\ Our conventions are to leave two spaces between sentences, not one. > +When set to \"ask\", a prompt may ask whether to enable or disable\n\ > +debuginfod." ), "a prompt may ask" sounds awkward and somewhat mysterious. How about When set to "ask", prompt whether to enable or disable [...] instead? > +@kindex maint set debuginfod > +@kindex maint show debuginfod > +@item maint set debuginfod download-sections > +@itemx maint set debuginfod download-sections @r{[}on|off@r{]} > +@itemx maint show debuginfod download-sections > +Controls whether @value{GDBN} will attempt to download individual > +ELF/DWARF sections from @code{debuginfod}. If disabled, only > +whole debug info files will be downloaded. This could result > +in @value{GDBN} downloading larger amounts of data. I'd make the last sentence a part of the one before it, for clarity of what "this" means. Like this: If disabled, only whole debug info files will be downloaded; this could result in @value{GDBN} downloading larger amounts of data. > @cindex @value{GDBN} internal error > @cindex internal errors, control of @value{GDBN} behavior > @cindex demangler crashes > @@ -49382,8 +49392,10 @@ regarding @code{debuginfod}. > @item set debuginfod enabled > @itemx set debuginfod enabled on > @cindex enable debuginfod > -@value{GDBN} will attempt to query @code{debuginfod} servers when missing debug > -info or source files. > +@value{GDBN} will attempt to query @code{debuginfod} servers for missing debug > +info or source files. Why "attempt to query"? why not just "query"? Or maybe "attempt to download"? > @value{GDBN} may attempt to download individual ELF/DWARF > +sections such as @code{.gdb_index} to help reduce the total amount of data > +downloaded from debuginfod servers. Once again, I'd drop the "attempt" part. More importantly, a cross-reference to where "maint set debuginfod" is described is missing here. I would suggest @value{GDBN} may download individual ELF/DWARF sections such as @code{.gdb_index} to help reduce the total amount of data downloaded from debuginfod servers; this can be controlled by @w{@code{maint set debuginfod download-sections}} (@pxref{Maintenance Commands, maint set debuginfod download-sections}). Reviewed-By: Eli Zaretskii