gcc/doc: spelling mistakes and example

Message ID ddc1341d-9c7c-46e2-a1d4-50223f31c089@jguk.org
State New
Headers
Series gcc/doc: spelling mistakes and example |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gcc_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gcc_check--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gcc_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gcc_check--master-aarch64 success Testing passed

Commit Message

Jonny Grant Dec. 3, 2023, 12:17 a.m. UTC
  2023-12-03  Jonathan Grant  <jg@jguk.org>

gcc/doc
	* install.texi: show ../ back from the objdir in the example invoking configure
	 correct spelling support, arithmetics


This page is what is generated from install.texi
https://gcc.gnu.org/install/configure.html



From c9fec3796600cc44c0839d0471935482612e4596 Mon Sep 17 00:00:00 2001
From: Jonathan Grant <jg@jguk.org>
Date: Sun, 3 Dec 2023 00:15:12 +0000
Subject: [PATCH]  gcc/doc: spelling mistakes and example

---
 gcc/doc/install.texi | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
  

Comments

Xi Ruoyao Dec. 3, 2023, 4:03 a.m. UTC | #1
On Sun, 2023-12-03 at 00:17 +0000, Jonny Grant wrote:
> @@ -733,7 +733,7 @@ To configure GCC:
>  @smallexample
>  % mkdir @var{objdir}
>  % cd @var{objdir}
> -% @var{srcdir}/configure [@var{options}] [@var{target}]
> +% ../@var{srcdir}/configure [@var{options}] [@var{target}]
>  @end smallexample

No, this is definitely incorrect.  srcdir is the path (it may be
relative or absolute) to the GCC source tree.  It's not necessary to be
placed in the parent directory of objdir.
  
Jonny Grant Dec. 3, 2023, 11:59 a.m. UTC | #2
On 03/12/2023 04:03, Xi Ruoyao wrote:
> On Sun, 2023-12-03 at 00:17 +0000, Jonny Grant wrote:
>> @@ -733,7 +733,7 @@ To configure GCC:
>>  @smallexample
>>  % mkdir @var{objdir}
>>  % cd @var{objdir}
>> -% @var{srcdir}/configure [@var{options}] [@var{target}]
>> +% ../@var{srcdir}/configure [@var{options}] [@var{target}]
>>  @end smallexample
> 
> No, this is definitely incorrect.  srcdir is the path (it may be
> relative or absolute) to the GCC source tree.  It's not necessary to be
> placed in the parent directory of objdir.
> 

Fair enough.

Can the spelling corrections still be merged? Or should I re-submit the patch without that line?

Kind regards, Jonny
  
David Malcolm Dec. 3, 2023, 5:55 p.m. UTC | #3
On Sun, 2023-12-03 at 11:59 +0000, Jonny Grant wrote:
> 
> 
> On 03/12/2023 04:03, Xi Ruoyao wrote:
> > On Sun, 2023-12-03 at 00:17 +0000, Jonny Grant wrote:
> > > @@ -733,7 +733,7 @@ To configure GCC:
> > >  @smallexample
> > >  % mkdir @var{objdir}
> > >  % cd @var{objdir}
> > > -% @var{srcdir}/configure [@var{options}] [@var{target}]
> > > +% ../@var{srcdir}/configure [@var{options}] [@var{target}]
> > >  @end smallexample
> > 
> > No, this is definitely incorrect.  srcdir is the path (it may be
> > relative or absolute) to the GCC source tree.  It's not necessary
> > to be
> > placed in the parent directory of objdir.
> > 
> 
> Fair enough.
> 
> Can the spelling corrections still be merged? Or should I re-submit
> the patch without that line?

The spelling corrections look OK to me.

Do you have an account that can push commits, or would you need this
done for you?

Please can you add Signed-off-by lines to your patches/commits
(via -s); see https://gcc.gnu.org/dco.html

Thanks
Dave

> 
> Kind regards, Jonny
>
  
Jonny Grant Jan. 10, 2024, 9:26 p.m. UTC | #4
On 03/12/2023 17:55, David Malcolm wrote:
> On Sun, 2023-12-03 at 11:59 +0000, Jonny Grant wrote:
>>
>>
>> On 03/12/2023 04:03, Xi Ruoyao wrote:
>>> On Sun, 2023-12-03 at 00:17 +0000, Jonny Grant wrote:
>>>> @@ -733,7 +733,7 @@ To configure GCC:
>>>>  @smallexample
>>>>  % mkdir @var{objdir}
>>>>  % cd @var{objdir}
>>>> -% @var{srcdir}/configure [@var{options}] [@var{target}]
>>>> +% ../@var{srcdir}/configure [@var{options}] [@var{target}]
>>>>  @end smallexample
>>>
>>> No, this is definitely incorrect.  srcdir is the path (it may be
>>> relative or absolute) to the GCC source tree.  It's not necessary
>>> to be
>>> placed in the parent directory of objdir.
>>>
>>
>> Fair enough.
>>
>> Can the spelling corrections still be merged? Or should I re-submit
>> the patch without that line?
> 
> The spelling corrections look OK to me.
> 
> Do you have an account that can push commits, or would you need this
> done for you?
> 
> Please can you add Signed-off-by lines to your patches/commits
> (via -s); see https://gcc.gnu.org/dco.html
> 
> Thanks
> Dave

Hi Dave

Would need someone to push the commits as I don't have an account.

I'll use -s for next patches, I've emailed again with the line added:

Signed-off-by: Jonathan Grant <jg@jguk.org>

Thanks, Jonny
  
Jonny Grant Feb. 8, 2024, 9:51 p.m. UTC | #5
On 10/01/2024 21:26, Jonny Grant wrote:
> 
> 
> On 03/12/2023 17:55, David Malcolm wrote:
>> On Sun, 2023-12-03 at 11:59 +0000, Jonny Grant wrote:
>>>
>>>
>>> On 03/12/2023 04:03, Xi Ruoyao wrote:
>>>> On Sun, 2023-12-03 at 00:17 +0000, Jonny Grant wrote:
>>>>> @@ -733,7 +733,7 @@ To configure GCC:
>>>>>  @smallexample
>>>>>  % mkdir @var{objdir}
>>>>>  % cd @var{objdir}
>>>>> -% @var{srcdir}/configure [@var{options}] [@var{target}]
>>>>> +% ../@var{srcdir}/configure [@var{options}] [@var{target}]
>>>>>  @end smallexample
>>>>
>>>> No, this is definitely incorrect.  srcdir is the path (it may be
>>>> relative or absolute) to the GCC source tree.  It's not necessary
>>>> to be
>>>> placed in the parent directory of objdir.
>>>>
>>>
>>> Fair enough.
>>>
>>> Can the spelling corrections still be merged? Or should I re-submit
>>> the patch without that line?
>>
>> The spelling corrections look OK to me.
>>
>> Do you have an account that can push commits, or would you need this
>> done for you?
>>
>> Please can you add Signed-off-by lines to your patches/commits
>> (via -s); see https://gcc.gnu.org/dco.html
>>
>> Thanks
>> Dave
> 
> Hi Dave
> 
> Would need someone to push the commits as I don't have an account.
> 
> I'll use -s for next patches, I've emailed again with the line added:
> 
> Signed-off-by: Jonathan Grant <jg@jguk.org>
> 
> Thanks, Jonny


Hi Dave

May I ask for review of my revised patch please.

https://gcc.gnu.org/pipermail/gcc-patches/2024-January/642539.html

Kind regards, Jonny
  

Patch

diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index c1ccb8ba02d..96a65aa5080 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -733,7 +733,7 @@  To configure GCC:
 @smallexample
 % mkdir @var{objdir}
 % cd @var{objdir}
-% @var{srcdir}/configure [@var{options}] [@var{target}]
+% ../@var{srcdir}/configure [@var{options}] [@var{target}]
 @end smallexample
 
 @heading Distributor options
@@ -1449,23 +1449,23 @@  for riscv*-*-elf*.  The accepted values and meanings are given below.
 Every config is constructed with four components: architecture string, ABI,
 reuse rule with architecture string and reuse rule with sub-extension.
 
-Example 1: Add multi-lib suppport for rv32i with ilp32.
+Example 1: Add multi-lib support for rv32i with ilp32.
 @smallexample
 rv32i-ilp32--
 @end smallexample
 
-Example 2: Add multi-lib suppport for rv32i with ilp32 and rv32imafd with ilp32.
+Example 2: Add multi-lib support for rv32i with ilp32 and rv32imafd with ilp32.
 @smallexample
 rv32i-ilp32--;rv32imafd-ilp32--
 @end smallexample
 
-Example 3: Add multi-lib suppport for rv32i with ilp32; rv32im with ilp32 and
+Example 3: Add multi-lib support for rv32i with ilp32; rv32im with ilp32 and
 rv32ic with ilp32 will reuse this multi-lib set.
 @smallexample
 rv32i-ilp32-rv32im-c
 @end smallexample
 
-Example 4: Add multi-lib suppport for rv64ima with lp64; rv64imaf with lp64,
+Example 4: Add multi-lib support for rv64ima with lp64; rv64imaf with lp64,
 rv64imac with lp64 and rv64imafc with lp64 will reuse this multi-lib set.
 @smallexample
 rv64ima-lp64--f,c,fc
@@ -1476,13 +1476,13 @@  rv64ima-lp64--f,c,fc
 config options, @var{val} is a comma separated list of possible code model,
 currently we support medlow and medany.
 
-Example 5: Add multi-lib suppport for rv64ima with lp64; rv64ima with lp64 and
+Example 5: Add multi-lib support for rv64ima with lp64; rv64ima with lp64 and
 medlow code model
 @smallexample
 rv64ima-lp64--;--cmodel=medlow
 @end smallexample
 
-Example 6: Add multi-lib suppport for rv64ima with lp64; rv64ima with lp64 and
+Example 6: Add multi-lib support for rv64ima with lp64; rv64ima with lp64 and
 medlow code model; rv64ima with lp64 and medany code model
 @smallexample
 rv64ima-lp64--;--cmodel=medlow,medany
@@ -1607,7 +1607,7 @@  libraries.  This option is only supported on Epiphany targets.
 
 @item --with-fpmath=@var{isa}
 This options sets @option{-mfpmath=sse} by default and specifies the default
-ISA for floating-point arithmetics.  You can select either @samp{sse} which
+ISA for floating-point arithmetic.  You can select either @samp{sse} which
 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
 This option is only supported on i386 and x86-64 targets.