diff mbox series

[1/2] gdb/doc: MPFR is now a necessary requirement

Message ID 20230306-doc-require-mpfr-fix-v1-1-8f207504dd3e@gmail.com
State New
Headers
Series doc: MPFR is now a necessary requirement |

Commit Message

Philippe Blain March 10, 2023, 5:46 p.m. UTC 
  Since 99118062785 (Use toplevel configure for GMP and MPFR for gdb,
2022-11-08), MPFR is mandatory for building GDB. That commit adjusted
the "Requirements for Building GDB" section of the documentation so that
the MPFR entry mentions "now uses" instead of "can use", but left the
whole entry under the "Tools/Packages Optional for Building GDB"
heading.

Move the MPFR entry to the "Tools/Packages Necessary for Building GDB"
heading.
---
 gdb/doc/gdb.texinfo | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

Comments

Eli Zaretskii March 10, 2023, 7:15 p.m. UTC | #1 
> Date: Fri, 10 Mar 2023 12:46:56 -0500
> Cc: Andrew Pinski <apinski@marvell.com>
> From: Philippe Blain via Gdb-patches <gdb-patches@sourceware.org>
> 
> Since 99118062785 (Use toplevel configure for GMP and MPFR for gdb,
> 2022-11-08), MPFR is mandatory for building GDB. That commit adjusted
> the "Requirements for Building GDB" section of the documentation so that
> the MPFR entry mentions "now uses" instead of "can use", but left the
> whole entry under the "Tools/Packages Optional for Building GDB"
> heading.
> 
> Move the MPFR entry to the "Tools/Packages Necessary for Building GDB"
> heading.
> ---
>  gdb/doc/gdb.texinfo | 30 +++++++++++++++---------------
>  1 file changed, 15 insertions(+), 15 deletions(-)

Thanks, this is OK.

Approved-By: Eli Zaretskii <eliz@gnu.org>
Simon Marchi March 27, 2023, 9:13 p.m. UTC | #2 
On 3/10/23 12:46, Philippe Blain via Gdb-patches wrote:
> Since 99118062785 (Use toplevel configure for GMP and MPFR for gdb,
> 2022-11-08), MPFR is mandatory for building GDB. That commit adjusted
> the "Requirements for Building GDB" section of the documentation so that
> the MPFR entry mentions "now uses" instead of "can use", but left the
> whole entry under the "Tools/Packages Optional for Building GDB"
> heading.
> 
> Move the MPFR entry to the "Tools/Packages Necessary for Building GDB"
> heading.
> ---
>  gdb/doc/gdb.texinfo | 30 +++++++++++++++---------------
>  1 file changed, 15 insertions(+), 15 deletions(-)
> 
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index 2a2077c29d1..218c2da9c86 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -39781,6 +39781,21 @@ 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
> +@anchor{MPFR}
> +@value{GDBN} now uses the GNU MPFR multiple-precision floating-point

Unlike in the NEWS file, where we describe the changes from one version
to another, the documentation is meant to describe the GDB version is
comes with.  Therefore, I find it odd to use "now" in the documentation.
I would just say "GDB uses the GNU MPFR...".  I know it's pre-existing
text and it's the same in the GMP paragraph, but it sounds weird there
too.  Imagine reading the doc 20 years down the road, and it says "GDB
now uses the GNU GMP...", as if it's a new thing.

Simon
Philippe Blain March 29, 2023, 5:21 p.m. UTC | #3 
Hi Simon,

Le 2023-03-27 à 17:13, Simon Marchi a écrit :
> On 3/10/23 12:46, Philippe Blain via Gdb-patches wrote:
>> Since 99118062785 (Use toplevel configure for GMP and MPFR for gdb,
>> 2022-11-08), MPFR is mandatory for building GDB. That commit adjusted
>> the "Requirements for Building GDB" section of the documentation so that
>> the MPFR entry mentions "now uses" instead of "can use", but left the
>> whole entry under the "Tools/Packages Optional for Building GDB"
>> heading.
>>
>> Move the MPFR entry to the "Tools/Packages Necessary for Building GDB"
>> heading.
>> ---
>>  gdb/doc/gdb.texinfo | 30 +++++++++++++++---------------
>>  1 file changed, 15 insertions(+), 15 deletions(-)
>>
>> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
>> index 2a2077c29d1..218c2da9c86 100644
>> --- a/gdb/doc/gdb.texinfo
>> +++ b/gdb/doc/gdb.texinfo
>> @@ -39781,6 +39781,21 @@ 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
>> +@anchor{MPFR}
>> +@value{GDBN} now uses the GNU MPFR multiple-precision floating-point
> 
> Unlike in the NEWS file, where we describe the changes from one version
> to another, the documentation is meant to describe the GDB version is
> comes with.  Therefore, I find it odd to use "now" in the documentation.
> I would just say "GDB uses the GNU MPFR...".  I know it's pre-existing
> text and it's the same in the GMP paragraph, but it sounds weird there
> too.  Imagine reading the doc 20 years down the road, and it says "GDB
> now uses the GNU GMP...", as if it's a new thing.

Yes, I agree. I avoided changing that to keep the existing text as is, and
indeed also because the GMP entry uses the same wording. 

I'll tweak both in v2. 

Thanks,

Philippe.
diff mbox series

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 2a2077c29d1..218c2da9c86 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -39781,6 +39781,21 @@  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
+@anchor{MPFR}
+@value{GDBN} now uses the GNU MPFR multiple-precision floating-point
+library.  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
+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}
@@ -39858,21 +39873,6 @@  the usual place, then the @file{configure} script will use it
 automatically.  If it is installed in an unusual path, you can use the
 @option{--with-liblzma-prefix} option to specify its location.
 
-@item MPFR
-@anchor{MPFR}
-@value{GDBN} now uses the GNU MPFR multiple-precision floating-point
-library.  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
-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.
-
 @item Python
 @value{GDBN} can be scripted using Python language.  @xref{Python}.
 By default, @value{GDBN} will be compiled if the Python libraries are