diff mbox series

multiflags: fix doc warning properly

Message ID orttoo6wb7.fsf_-_@lxoliva.fsfla.org
State Unresolved
Headers
Series multiflags: fix doc warning properly |

Checks

Context Check Description
snail/gcc-patch-check warning Git am fail log

Commit Message

Alexandre Oliva Dec. 12, 2023, 1:31 a.m. UTC 
  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(-)

Comments

Joseph Myers Dec. 12, 2023, 3:02 p.m. UTC | #1 
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.
diff mbox series

Patch

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