[PATCH] multiflags: fix doc warning

[PATCH] multiflags: fix doc warning

[Alexandre Oliva]

Comply with dubious doc warning that after an @xref there must be a
comma or a period, not a close parentheses.

Build-testing on x86_64-linux-gnu now.  Ok to install?


for  gcc/ChangeLog

	* doc/invoke.texi (multiflags): Add period after @xref to
	silence warning.
---
 gcc/doc/invoke.texi |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index d4e689b64c010..4e67c95dbf85a 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -20589,7 +20589,7 @@ allocation before or after interprocedural optimization.
 This option enables multilib-aware @code{TFLAGS} to be used to build
 target libraries with options different from those the compiler is
 configured to use by default, through the use of specs (@xref{Spec
-Files}) set up by compiler internals, by the target, or by builders at
+Files}.) set up by compiler internals, by the target, or by builders at
 configure time.
 
 Like @code{TFLAGS}, this allows the target libraries to be built for

-- 
Alexandre Oliva, happy hacker            https://FSFLA.org/blogs/lxo/
   Free Software Activist                   GNU Toolchain Engineer
More tolerance and less prejudice are key for inclusion and diversity
Excluding neuro-others for not behaving ""normal"" is *not* inclusive

Re: [PATCH] multiflags: fix doc warning

[Jeff Law]

On 12/8/23 19:48, Alexandre Oliva wrote:
> 
> Comply with dubious doc warning that after an @xref there must be a
> comma or a period, not a close parentheses.
> 
> Build-testing on x86_64-linux-gnu now.  Ok to install?
> 
> 
> for  gcc/ChangeLog
> 
> 	* doc/invoke.texi (multiflags): Add period after @xref to
> 	silence warning.
OK
jeff

Re: [PATCH] multiflags: fix doc warning

[Joseph Myers]

On Fri, 8 Dec 2023, Alexandre Oliva wrote:

> @@ -20589,7 +20589,7 @@ allocation before or after interprocedural optimization.
>  This option enables multilib-aware @code{TFLAGS} to be used to build
>  target libraries with options different from those the compiler is
>  configured to use by default, through the use of specs (@xref{Spec
> -Files}) set up by compiler internals, by the target, or by builders at
> +Files}.) set up by compiler internals, by the target, or by builders at

The proper change in this context is to use @pxref instead of @xref.


-- 
Joseph S. Myers
joseph@codesourcery.com

[PATCH] multiflags: fix doc warning properly

[Alexandre Oliva]

On Dec 11, 2023, Joseph Myers <joseph@codesourcery.com> wrote:

> On Fri, 8 Dec 2023, Alexandre Oliva wrote:
>> @@ -20589,7 +20589,7 @@ allocation before or after interprocedural optimization.
>> This option enables multilib-aware @code{TFLAGS} to be used to build
>> target libraries with options different from those the compiler is
>> configured to use by default, through the use of specs (@xref{Spec
>> -Files}) set up by compiler internals, by the target, or by builders at
>> +Files}.) set up by compiler internals, by the target, or by builders at

> The proper change in this context is to use @pxref instead of @xref.

Oooh, nice!  Thank you!

Here's a presumably proper fix on top of the earlier one, then.  Tested
on x86_64-linux-gnu.  Ok to install?


Rather than a dubious fix for a dubious warning, namely adding a
period after a parenthesized @xref because the warning demands it, use
@pxref that is meant for exactly this case.  Thanks to Joseph Myers
for introducing me to it.


for  gcc/ChangeLog

	* doc/invoke.texi (multiflags): Drop extraneous period, use
	@pxref instead.
---
 gcc/doc/invoke.texi |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 7d15cf94821e3..ce4bb025d5144 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -20588,8 +20588,8 @@ allocation before or after interprocedural optimization.
 @item -fmultiflags
 This option enables multilib-aware @code{TFLAGS} to be used to build
 target libraries with options different from those the compiler is
-configured to use by default, through the use of specs (@xref{Spec
-Files}.) set up by compiler internals, by the target, or by builders at
+configured to use by default, through the use of specs (@pxref{Spec
+Files}) set up by compiler internals, by the target, or by builders at
 configure time.
 
 Like @code{TFLAGS}, this allows the target libraries to be built for


-- 
Alexandre Oliva, happy hacker            https://FSFLA.org/blogs/lxo/
   Free Software Activist                   GNU Toolchain Engineer
More tolerance and less prejudice are key for inclusion and diversity
Excluding neuro-others for not behaving ""normal"" is *not* inclusive

Re: [PATCH] multiflags: fix doc warning properly

[Joseph Myers]

On Mon, 11 Dec 2023, Alexandre Oliva wrote:

> On Dec 11, 2023, Joseph Myers <joseph@codesourcery.com> wrote:
> 
> > On Fri, 8 Dec 2023, Alexandre Oliva wrote:
> >> @@ -20589,7 +20589,7 @@ allocation before or after interprocedural optimization.
> >> This option enables multilib-aware @code{TFLAGS} to be used to build
> >> target libraries with options different from those the compiler is
> >> configured to use by default, through the use of specs (@xref{Spec
> >> -Files}) set up by compiler internals, by the target, or by builders at
> >> +Files}.) set up by compiler internals, by the target, or by builders at
> 
> > The proper change in this context is to use @pxref instead of @xref.
> 
> Oooh, nice!  Thank you!
> 
> Here's a presumably proper fix on top of the earlier one, then.  Tested
> on x86_64-linux-gnu.  Ok to install?
> 
> 
> Rather than a dubious fix for a dubious warning, namely adding a
> period after a parenthesized @xref because the warning demands it, use
> @pxref that is meant for exactly this case.  Thanks to Joseph Myers
> for introducing me to it.

OK.

-- 
Joseph S. Myers
joseph@codesourcery.com