]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commit
gdb/manual: Move @findex entries
authorPedro Alves <pedro@palves.net>
Mon, 13 Feb 2023 16:14:55 +0000 (16:14 +0000)
committerPedro Alves <pedro@palves.net>
Wed, 15 Feb 2023 15:28:33 +0000 (15:28 +0000)
commit71e28f788f4e5489501646093c6a34e01681d35b
tree1cf1c62d781ce1ae95315c5195009bc67b69d54c
parentf9c36cc99518c74a0562e86e1e27ec46cf57d49a
gdb/manual: Move @findex entries

The manual currently has many cases like these:

 @item $_gdb_setting_str (@var{setting})
 @findex $_gdb_setting_str@r{, convenience function}

As suggested by Eli, move the @findex entries before @item so that the
index records the position of @item, and the Info reader places you
there when you use index-search.

I went over all @findex calls in the manual, and most are like the
above.  Most either appear before @item, or before @subheading, like:

 @subheading The @code{-break-after} Command
 @findex -break-after

I fixed all of them.

There are findex entries in annotate.texinfo,python.texi, and
stabs.texinfo as well, though those all look right to me already.

Tested by typing "i _isvoid" (@item case) and "i -complete"
(@subheading case) in an Info reader, and checking where those took
me.

Change-Id: Idb6903b0bb39ff03f93524628dcef86b5585c97e
Suggested-By: Eli Zaretskii <eliz@gnu.org>
gdb/doc/gdb.texinfo