[binutils-gdb] [libctf] Fix warning: @xref should not appear on @multitable line

Tom de Vries vries@sourceware.org
Tue Feb 25 07:28:58 GMT 2025


https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=f40b59b91240886003b679ff4a3fd51b6b60696a

commit f40b59b91240886003b679ff4a3fd51b6b60696a
Author: Tom de Vries <tdevries@suse.de>
Date:   Tue Feb 25 08:29:19 2025 +0100

    [libctf] Fix warning: @xref should not appear on @multitable line
    
    When building gdb, I run into:
    ...
    ctf-spec.texi:809: warning: @xref should not appear on @multitable line
    ...
    
    The line in question is:
    ...
    @multitable {Kind} {@code{CTF_K_VOLATILE}} {Indicates a type that cannot be represented in CTF, or that} {@xref{Pointers typedefs and cvr-quals}}
    ...
    which defines a prototype row with 4 columns.
    
    However, the table only has 3 colums:
    ...
    @headitem Kind @tab Macro @tab Purpose
    ...
    
    Fix the warning by removing the item in the prototype row representing a fourth column.
    
    Tested on aarch64-linux.
    
    PR libctf/32044
    Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=32044

Diff:
---
 libctf/doc/ctf-spec.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/libctf/doc/ctf-spec.texi b/libctf/doc/ctf-spec.texi
index a79ee5ed083..5b2b881a895 100644
--- a/libctf/doc/ctf-spec.texi
+++ b/libctf/doc/ctf-spec.texi
@@ -806,7 +806,7 @@ just very frequently @emph{referenced}.)
 Here's the set of kinds so far.  Each kind has a @code{#define} associated with
 it, also given here.
 
-@multitable {Kind} {@code{CTF_K_VOLATILE}} {Indicates a type that cannot be represented in CTF, or that} {@xref{Pointers typedefs and cvr-quals}}
+@multitable {Kind} {@code{CTF_K_VOLATILE}} {Indicates a type that cannot be represented in CTF, or that}
 @headitem Kind @tab Macro @tab Purpose
 @item 0
 @tab @code{CTF_K_UNKNOWN}


More information about the Binutils-cvs mailing list