gdb/doc: Fix incorrect use of @xref.
Commit Message
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(-)
Comments
> 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.
@@ -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.
@@ -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