Message ID | 20230306-doc-require-mpfr-fix-v1-2-8f207504dd3e@gmail.com |
---|---|
State | New |
Headers |
Return-Path: <gdb-patches-bounces+patchwork=sourceware.org@sourceware.org> X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 48CC0385B528 for <patchwork@sourceware.org>; Fri, 10 Mar 2023 17:47:31 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 48CC0385B528 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1678470451; bh=n6E7/9iCmlZhnzkm6wu1RViyXEB7Crq9JRe9oJG8taE=; h=Date:Subject:References:In-Reply-To:To:Cc:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From:Reply-To:From; b=CfdQqfKuCUQIhxAXi6FCWPARzUae7uu7lUU4Mh0rgpUrUptx/UWn4CZysuQRxzwYu z8jn9noz3FQYVh+HCwVtJPfbMtMhg6fjHobhT8haDjK9kJlJdDsGo2DmHdQhdQ/9bu j/3GrlxSWMYVbIsDIIxuO3xgt0dxKEdl3G2nzOr0= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-qt1-x82a.google.com (mail-qt1-x82a.google.com [IPv6:2607:f8b0:4864:20::82a]) by sourceware.org (Postfix) with ESMTPS id 5C8FE3858D3C for <gdb-patches@sourceware.org>; Fri, 10 Mar 2023 17:47:04 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 5C8FE3858D3C Received: by mail-qt1-x82a.google.com with SMTP id c3so6577751qtc.8 for <gdb-patches@sourceware.org>; Fri, 10 Mar 2023 09:47:04 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1678470423; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=n6E7/9iCmlZhnzkm6wu1RViyXEB7Crq9JRe9oJG8taE=; b=Cz2B/+wGb5tVhyBgL2xcHaYCSv30a2LMoeEtZ7StOQD2RDFHJZkPyhEthUBsw5o4HR xWP4fSxMCzcVUlOuD00UQReb9SybqohlUdszQ2dM80I4IoaTDnYNvGZ9nIAr1+hSUd7T g95ZD1e9qw6P20r8QtIEKTWc+7kB51dpFeg+M96IVxLnVCxsIPQiEoV4nI7LqKugEjaq MtWEW6hGsbyOr4v6Q4OonvS0adFsPHEC54yuvJko8VadZwk2qfn4/YBWnPQOFCdcdF7m OEFUyXR8BAnsQlypYxqQX26KbtV45HL4zpLklMMZf/jBTprSNljFsBzgBbAZN/T8pEpN 9pdg== X-Gm-Message-State: AO0yUKUsORpE3gSpdj7dJ58X9I9KbVz/SS34gtNKLxg+rtHv9Y8JX5Zq +67c8DoAOht0f23h31L+yvQ= X-Google-Smtp-Source: AK7set9CAMsiixu8I3SF0HMe4Pn1knmrfziWtN2mH+GQNTBko1Q11smBNeMW2gFIXgAJg6IRe7cJuA== X-Received: by 2002:a05:622a:118b:b0:3bf:d1ba:daec with SMTP id m11-20020a05622a118b00b003bfd1badaecmr41491050qtk.16.1678470423668; Fri, 10 Mar 2023 09:47:03 -0800 (PST) Received: from WQUEN758573.ncr.int.ec.gc.ca (ecodor131.cmc.ec.gc.ca. [205.211.133.131]) by smtp.gmail.com with ESMTPSA id f4-20020ac84704000000b003bfaf01af24sm220249qtp.46.2023.03.10.09.47.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 10 Mar 2023 09:47:03 -0800 (PST) Date: Fri, 10 Mar 2023 12:46:57 -0500 Subject: [PATCH 2/2] gdb/doc: uniformize wording for GMP and MPFR entries MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20230306-doc-require-mpfr-fix-v1-2-8f207504dd3e@gmail.com> References: <20230306-doc-require-mpfr-fix-v1-0-8f207504dd3e@gmail.com> In-Reply-To: <20230306-doc-require-mpfr-fix-v1-0-8f207504dd3e@gmail.com> To: gdb-patches@sourceware.org Cc: Andrew Pinski <apinski@marvell.com> X-Mailer: b4 0.13-dev-10ee4 X-Spam-Status: No, score=-10.7 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list <gdb-patches.sourceware.org> List-Unsubscribe: <https://sourceware.org/mailman/options/gdb-patches>, <mailto:gdb-patches-request@sourceware.org?subject=unsubscribe> List-Archive: <https://sourceware.org/pipermail/gdb-patches/> List-Post: <mailto:gdb-patches@sourceware.org> List-Help: <mailto:gdb-patches-request@sourceware.org?subject=help> List-Subscribe: <https://sourceware.org/mailman/listinfo/gdb-patches>, <mailto:gdb-patches-request@sourceware.org?subject=subscribe> From: Philippe Blain via Gdb-patches <gdb-patches@sourceware.org> Reply-To: Philippe Blain <levraiphilippeblain@gmail.com> Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" <gdb-patches-bounces+patchwork=sourceware.org@sourceware.org> |
Series |
doc: MPFR is now a necessary requirement
|
|
Commit Message
Philippe Blain
March 10, 2023, 5:46 p.m. UTC
Make the wording of the GMP and MPFR entries in the "Requirements for Building GDB" section of the documentation more uniform by: - mentioning the configure script in the GMP entry, as is done in the MPFR entry - adding the long name of the MPFR library between parenthesis, as is done in the GMP entry - removing the second paragraph of the MPFR entry and moving its content to the first one, mimicking the wording of the GMP entry --- gdb/doc/gdb.texinfo | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-)
Comments
> Date: Fri, 10 Mar 2023 12:46:57 -0500 > Cc: Andrew Pinski <apinski@marvell.com> > From: Philippe Blain via Gdb-patches <gdb-patches@sourceware.org> > > Make the wording of the GMP and MPFR entries in the "Requirements for > Building GDB" section of the documentation more uniform by: > > - mentioning the configure script in the GMP entry, as is done in the > MPFR entry > - adding the long name of the MPFR library between parenthesis, as is > done in the GMP entry > - removing the second paragraph of the MPFR entry and moving its content > to the first one, mimicking the wording of the GMP entry > --- > gdb/doc/gdb.texinfo | 13 ++++++------- > 1 file changed, 6 insertions(+), 7 deletions(-) I don't mind the changes, but I also don't mind leaving the original text intact: there's nothing wrong with it per se. Thanks. Reviewed-By: Eli Zaretskii <eliz@gnu.org>
Hi Eli, Le 2023-03-10 à 14:17, Eli Zaretskii a écrit : >> Date: Fri, 10 Mar 2023 12:46:57 -0500 >> Cc: Andrew Pinski <apinski@marvell.com> >> From: Philippe Blain via Gdb-patches <gdb-patches@sourceware.org> >> >> Make the wording of the GMP and MPFR entries in the "Requirements for >> Building GDB" section of the documentation more uniform by: >> >> - mentioning the configure script in the GMP entry, as is done in the >> MPFR entry >> - adding the long name of the MPFR library between parenthesis, as is >> done in the GMP entry >> - removing the second paragraph of the MPFR entry and moving its content >> to the first one, mimicking the wording of the GMP entry >> --- >> gdb/doc/gdb.texinfo | 13 ++++++------- >> 1 file changed, 6 insertions(+), 7 deletions(-) > > I don't mind the changes, but I also don't mind leaving the original > text intact: there's nothing wrong with it per se. > > Thanks. > > Reviewed-By: Eli Zaretskii <eliz@gnu.org> > Thanks for the reviwew. I do not have push access, would you be so kind as to push both patches ? Thanks, Philippe.
> Cc: gdb-patches@sourceware.org, apinski@marvell.com > From: Philippe Blain <levraiphilippeblain@gmail.com> > Date: Mon, 13 Mar 2023 12:45:04 -0400 > > Hi Eli, > > Le 2023-03-10 à 14:17, Eli Zaretskii a écrit : > >> Date: Fri, 10 Mar 2023 12:46:57 -0500 > >> Cc: Andrew Pinski <apinski@marvell.com> > >> From: Philippe Blain via Gdb-patches <gdb-patches@sourceware.org> > >> > >> Make the wording of the GMP and MPFR entries in the "Requirements for > >> Building GDB" section of the documentation more uniform by: > >> > >> - mentioning the configure script in the GMP entry, as is done in the > >> MPFR entry > >> - adding the long name of the MPFR library between parenthesis, as is > >> done in the GMP entry > >> - removing the second paragraph of the MPFR entry and moving its content > >> to the first one, mimicking the wording of the GMP entry > >> --- > >> gdb/doc/gdb.texinfo | 13 ++++++------- > >> 1 file changed, 6 insertions(+), 7 deletions(-) > > > > I don't mind the changes, but I also don't mind leaving the original > > text intact: there's nothing wrong with it per se. > > > > Thanks. > > > > Reviewed-By: Eli Zaretskii <eliz@gnu.org> > > > > Thanks for the reviwew. I do not have push access, would you be so > kind as to push both patches ? My preference is to install only the first of these, for the reasons I explained, but I'm waiting to hear opinions of others, if they differ.
Hi Eli, Le 2023-03-14 à 08:08, Eli Zaretskii a écrit : >> Cc: gdb-patches@sourceware.org, apinski@marvell.com >> From: Philippe Blain <levraiphilippeblain@gmail.com> >> Date: Mon, 13 Mar 2023 12:45:04 -0400 >> >> Hi Eli, >> >> Le 2023-03-10 à 14:17, Eli Zaretskii a écrit : >>>> Date: Fri, 10 Mar 2023 12:46:57 -0500 >>>> Cc: Andrew Pinski <apinski@marvell.com> >>>> From: Philippe Blain via Gdb-patches <gdb-patches@sourceware.org> >>>> >>>> Make the wording of the GMP and MPFR entries in the "Requirements for >>>> Building GDB" section of the documentation more uniform by: >>>> >>>> - mentioning the configure script in the GMP entry, as is done in the >>>> MPFR entry >>>> - adding the long name of the MPFR library between parenthesis, as is >>>> done in the GMP entry >>>> - removing the second paragraph of the MPFR entry and moving its content >>>> to the first one, mimicking the wording of the GMP entry >>>> --- >>>> gdb/doc/gdb.texinfo | 13 ++++++------- >>>> 1 file changed, 6 insertions(+), 7 deletions(-) >>> >>> I don't mind the changes, but I also don't mind leaving the original >>> text intact: there's nothing wrong with it per se. >>> >>> Thanks. >>> >>> Reviewed-By: Eli Zaretskii <eliz@gnu.org> >>> >> >> Thanks for the reviwew. I do not have push access, would you be so >> kind as to push both patches ? > > My preference is to install only the first of these, for the reasons I > explained, but I'm waiting to hear opinions of others, if they differ. OK, thanks. let's wait a bit to see if someone else wants to chime in. I guess I was confused by the fact that 'Approved-by' is used here in a different way than in the Git project, where it is an explicit approval (and Approved-by is not used). Maybe an argument for the second patch is that since the first patch makes the GMP and MPFR neighboring entries, it makes more sense to uniformize the wording between the two entries. At least, this is why I made this change: it looked a bit off when I read the doc after only the first patch. Thanks, Philippe.
Le 2023-03-14 à 13:12, Philippe Blain a écrit : > Hi Eli, > [...] > > I guess I was confused by the fact that 'Approved-by' is used here in a different way > than in the Git project, where it is an explicit approval I meant 'Reviewed-by' here, sorry.
> Cc: gdb-patches@sourceware.org, apinski@marvell.com > From: Philippe Blain <levraiphilippeblain@gmail.com> > Date: Tue, 14 Mar 2023 13:12:19 -0400 > > >>> Reviewed-By: Eli Zaretskii <eliz@gnu.org> > >>> > >> > >> Thanks for the reviwew. I do not have push access, would you be so > >> kind as to push both patches ? > > > > My preference is to install only the first of these, for the reasons I > > explained, but I'm waiting to hear opinions of others, if they differ. > > OK, thanks. let's wait a bit to see if someone else wants to chime in. > > I guess I was confused by the fact that 'Approved-by' is used here in a different way > than in the Git project, where it is an explicit approval (and Approved-by is not used). I didn't give Approved-by, I gave Reviewed-By.
> From: Philippe Blain <levraiphilippeblain@gmail.com> > Cc: gdb-patches@sourceware.org, apinski@marvell.com > Date: Tue, 14 Mar 2023 13:38:08 -0400 > > Le 2023-03-14 à 13:12, Philippe Blain a écrit : > > Hi Eli, > > > [...] > > > > I guess I was confused by the fact that 'Approved-by' is used here in a different way > > than in the Git project, where it is an explicit approval > > I meant 'Reviewed-by' here, sorry. Do they really use Reviewed-by as an approval? _That_ would be confusing, since the word "review" means just that, it doesn't mean any approval.
Hi Eli, Le 2023-03-14 à 15:41, Eli Zaretskii a écrit : >> From: Philippe Blain <levraiphilippeblain@gmail.com> >> Cc: gdb-patches@sourceware.org, apinski@marvell.com >> Date: Tue, 14 Mar 2023 13:38:08 -0400 >> >> Le 2023-03-14 à 13:12, Philippe Blain a écrit : >>> Hi Eli, >>> >> [...] >>> >>> I guess I was confused by the fact that 'Approved-by' is used here in a different way >>> than in the Git project, where it is an explicit approval >> >> I meant 'Reviewed-by' here, sorry. > > Do they really use Reviewed-by as an approval? _That_ would be > confusing, since the word "review" means just that, it doesn't mean > any approval. > Yes, in the Git project, Reviewd-by is approval, see for example item 3. at https://git-scm.com/docs/SubmittingPatches#sign-off (under "If you like, you can put extra tags at the end"): Reviewed-by:, unlike the other tags, can only be offered by the reviewers themselves when they are completely satisfied with the patch after a detailed analysis. This is in line with what it means for Linux also, as far as I understand [1]. Thanks, Philippe. [1] https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes
> My preference is to install only the first of these, for the reasons I > explained, but I'm waiting to hear opinions of others, if they differ. Since you are waiting for some opinion, I'll give mine. I like the more uniform text after patch 2. I like having the description of why GDB uses the library at the start (even if it's just informative, it doesn't help the user accomplish anything in the end). I think that the change that mentions the "configure" script is nice, otherwise it can be unclear where to use those --with-gmp/--with-gmp-include/--with-gmp-lib options. Simon
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 218c2da9c86..44e3859658e 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -39776,15 +39776,18 @@ make program. Other variants of @code{make} will not work. @value{GDBN} now uses GMP to perform some of its arithmetics. This library may be included with your operating system distribution; if it is not, you can get the latest version from -@url{https://gmplib.org/}. If GMP is installed at an unusual path, +@url{https://gmplib.org/}. The @file{configure} script will search +for this library in several standard locations; if it is installed at an unusual path, you can use the @option{--with-gmp} option or options @option{--with-gmp-include} and @option{--with-gmp-lib} to specify its location. -@item MPFR +@item MPFR (The GNU MPFR Library) @anchor{MPFR} @value{GDBN} now uses the GNU MPFR multiple-precision floating-point -library. This library may be included with your operating system +library to emulate target floating-point arithmetic during +expression evaluation when the target uses different floating-point +formats than the host. This library may be included with your operating system distribution; if it is not, you can get the latest version from @url{http://www.mpfr.org}. The @file{configure} script will search for this library in several standard locations; if it is installed @@ -39792,10 +39795,6 @@ in an unusual path, you can use the @option{--with-mpfr} option or options @option{--with-mpfr-include} and @option{--with-mpfr-lib} to specify its location. -GNU MPFR is used to emulate target floating-point arithmetic during -expression evaluation when the target uses different floating-point -formats than the host. - @end table @heading Tools/Packages Optional for Building @value{GDBN}