* [PATCH] gdb/doc: Fix incorrect use of @xref.
@ 2015-07-06 11:46 Andrew Burgess
2015-07-06 17:04 ` Eli Zaretskii
0 siblings, 1 reply; 2+ messages in thread
From: Andrew Burgess @ 2015-07-06 11:46 UTC (permalink / raw)
To: gdb-patches, Eli Zaretskii; +Cc: Dilyan Palauzov, Andrew Burgess
It has been pointed out to me that in commit a4ea0946c I introduced a
use of @xref that is not followed by either a ',' or a '.' as it is
supposed to be[1].
Normally I would push such a trivial change as an obvious fix,
however, I'm a little more nervous when it comes to documentation
changes, so I'd like a review please.
Thanks,
Andrew
[1] http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Reference-Syntax.html#Reference-Syntax
--
All uses of @xref must be followed by either '.' or ','. In commit
a4ea0946c an incorrect use of @xref was introduced. This commit
switches to using @ref in order to avoid the need for '.' or ','.
gdb/ChangeLog:
* doc/gdb.texinfo (TUI): Switch use of @xref to @ref.
---
gdb/ChangeLog | 4 ++++
gdb/doc/gdb.texinfo | 2 +-
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 201af51..319d504 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2015-07-06 Andrew Burgess <andrew.burgess@embecosm.com>
+
+ * doc/gdb.texinfo (TUI): Switch use of @xref to @ref.
+
2015-07-02 Kevin Buettner <kevinb@redhat.com>
* rx-tdep.c (RX_USP_REGNUM, RX_BPC_REGNUM): New constants.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 812917b..d3f17bc 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -24781,7 +24781,7 @@ The TUI mode is enabled by default when you invoke @value{GDBN} as
@samp{@value{GDBP} -tui}.
You can also switch in and out of TUI mode while @value{GDBN} runs by
using various TUI commands and key bindings, such as @command{tui
-enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands} and
+enable} or @kbd{C-x C-a}. See @ref{TUI Commands, ,TUI Commands} and
@ref{TUI Keys, ,TUI Key Bindings}.
@node TUI Overview
--
2.4.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] gdb/doc: Fix incorrect use of @xref.
2015-07-06 11:46 [PATCH] gdb/doc: Fix incorrect use of @xref Andrew Burgess
@ 2015-07-06 17:04 ` Eli Zaretskii
0 siblings, 0 replies; 2+ messages in thread
From: Eli Zaretskii @ 2015-07-06 17:04 UTC (permalink / raw)
To: Andrew Burgess; +Cc: gdb-patches, dilyan.palauzov, andrew.burgess
> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Cc: Dilyan Palauzov <dilyan.palauzov@aegee.org>,
> Andrew Burgess <andrew.burgess@embecosm.com>
> Date: Mon, 6 Jul 2015 12:45:33 +0100
>
> It has been pointed out to me that in commit a4ea0946c I introduced a
> use of @xref that is not followed by either a ',' or a '.' as it is
> supposed to be[1].
>
> Normally I would push such a trivial change as an obvious fix,
> however, I'm a little more nervous when it comes to documentation
> changes, so I'd like a review please.
Thanks. I suggest simply to add a comma after the xref's closing
brace. That's the schoolbook solution for these problems.
Sorry for not catching this during my review.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2015-07-06 17:04 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-07-06 11:46 [PATCH] gdb/doc: Fix incorrect use of @xref Andrew Burgess
2015-07-06 17:04 ` Eli Zaretskii
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).