From 0ca4866abeb9ff668fe64064fc1bceb08ca63833 Mon Sep 17 00:00:00 2001 From: Artur Shepilko Date: Wed, 15 Apr 2020 09:44:12 +0200 Subject: [PATCH] Fix makeinfo warnings in gdb.texinfo and python.texi docs Building gdb-9.1 on a system that has an older version of makeinfo (4.8) shows the following warnings: ----------------- make[4]: Entering directory '/home/tester/gdb-9.1/build/gdb/doc' makeinfo --split-size=5000000 --split-size=5000000 -I ../../../gdb/doc/../../readline/readline/doc -I ../../../gdb/doc/../mi -I ../../../gdb/doc \ -o gdb.info ../../../gdb/doc/gdb.texinfo ../../../gdb/doc/gdb.texinfo:21867: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21867: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21868: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21868: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21869: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21869: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21872: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21872: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21874: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21874: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21876: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21876: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21879: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21879: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21931: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21931: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21933: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21933: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21936: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21936: warning: unlikely character ] in @var. ../../../gdb/doc/gdb.texinfo:21939: warning: unlikely character [ in @var. ../../../gdb/doc/gdb.texinfo:21939: warning: unlikely character ] in @var. ../../../gdb/doc//python.texi:3297: warning: `.' or `,' must follow @xref, not `A'. make[4]: Leaving directory '/home/tester/gdb-9.1/build/gdb/doc' ----------------- These are thrown by expressions like `@var{[host]}`, intended to produce `[HOST]`. In that context this should instead be changed to `[@var{host}]`, which has the same effect but without the warnings. As for the warning in `python.texi`, there's period missing at the end of one `@xref{}` clause. Added. gdb/doc/ChangeLog: 2020-04-15 Artur Shepilko * gdb.texinfo: Transform @var{[host]} to [@var{host}]; this clears makeinfo warnings. * python.texi: Add a missing period trailing an @xref{} clause; this clears a makeinfo warning. --- gdb/doc/ChangeLog | 7 +++++++ gdb/doc/gdb.texinfo | 20 ++++++++++---------- gdb/doc/python.texi | 2 +- 3 files changed, 18 insertions(+), 11 deletions(-) diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 2be283f714c..0dc64768325 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,10 @@ +2020-04-15 Artur Shepilko + + * gdb.texinfo: Transform @var{[host]} to [@var{host}]; this + clears makeinfo warnings. + * python.texi: Add a missing period trailing an @xref{} clause; + this clears a makeinfo warning. + 2020-03-06 Tom de Vries * gdb.texinfo: Fix "the the". diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 385c832f222..239c078af33 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -21952,19 +21952,19 @@ This feature is not available if the host system does not support Unix domain sockets. @item target remote @code{@var{host}:@var{port}} -@itemx target remote @code{@var{[host]}:@var{port}} +@itemx target remote @code{[@var{host}]:@var{port}} @itemx target remote @code{tcp:@var{host}:@var{port}} -@itemx target remote @code{tcp:@var{[host]}:@var{port}} +@itemx target remote @code{tcp:[@var{host}]:@var{port}} @itemx target remote @code{tcp4:@var{host}:@var{port}} @itemx target remote @code{tcp6:@var{host}:@var{port}} -@itemx target remote @code{tcp6:@var{[host]}:@var{port}} +@itemx target remote @code{tcp6:[@var{host}]:@var{port}} @itemx target extended-remote @code{@var{host}:@var{port}} -@itemx target extended-remote @code{@var{[host]}:@var{port}} +@itemx target extended-remote @code{[@var{host}]:@var{port}} @itemx target extended-remote @code{tcp:@var{host}:@var{port}} -@itemx target extended-remote @code{tcp:@var{[host]}:@var{port}} +@itemx target extended-remote @code{tcp:[@var{host}]:@var{port}} @itemx target extended-remote @code{tcp4:@var{host}:@var{port}} @itemx target extended-remote @code{tcp6:@var{host}:@var{port}} -@itemx target extended-remote @code{tcp6:@var{[host]}:@var{port}} +@itemx target extended-remote @code{tcp6:[@var{host}]:@var{port}} @cindex @acronym{TCP} port, @code{target remote} Debug using a @acronym{TCP} connection to @var{port} on @var{host}. The @var{host} may be either a host name, a numeric @acronym{IPv4} @@ -22016,15 +22016,15 @@ target remote :1234 Note that the colon is still required here. @item target remote @code{udp:@var{host}:@var{port}} -@itemx target remote @code{udp:@var{[host]}:@var{port}} +@itemx target remote @code{udp:[@var{host}]:@var{port}} @itemx target remote @code{udp4:@var{host}:@var{port}} -@itemx target remote @code{udp6:@var{[host]}:@var{port}} +@itemx target remote @code{udp6:[@var{host}]:@var{port}} @itemx target extended-remote @code{udp:@var{host}:@var{port}} @itemx target extended-remote @code{udp:@var{host}:@var{port}} -@itemx target extended-remote @code{udp:@var{[host]}:@var{port}} +@itemx target extended-remote @code{udp:[@var{host}]:@var{port}} @itemx target extended-remote @code{udp4:@var{host}:@var{port}} @itemx target extended-remote @code{udp6:@var{host}:@var{port}} -@itemx target extended-remote @code{udp6:@var{[host]}:@var{port}} +@itemx target extended-remote @code{udp6:[@var{host}]:@var{port}} @cindex @acronym{UDP} port, @code{target remote} Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}: diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 76cdf7f5419..31e89950229 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -3295,7 +3295,7 @@ is no selected thread, this will return @code{None}. @end defun To get the list of threads for an inferior, use the @code{Inferior.threads()} -method. @xref{Inferiors In Python} +method. @xref{Inferiors In Python}. A @code{gdb.InferiorThread} object has the following attributes: -- 2.30.2