[gdb/doc] Mention index cache in concept and command index

Message ID 20190514075934.GA5425@delia
State New
Headers show
Series
  • [gdb/doc] Mention index cache in concept and command index
Related show

Commit Message

Tom de Vries May 14, 2019, 7:59 a.m.
Hi,

The "automatic symbol index cache" entry in the docs is missing entries in the
concept and command indices.  Add them.

OK for trunk?

Thanks,
- Tom

[gdb/doc] Mention index cache in concept and command index

gdb/doc/ChangeLog:

2019-05-14  Tom de Vries  <tdevries@suse.de>

	* gdb.texinfo (Automatic symbol index cache): Add concept and command
	index entries.

---
 gdb/doc/gdb.texinfo | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Eli Zaretskii May 14, 2019, 3:30 p.m. | #1
> Date: Tue, 14 May 2019 09:59:35 +0200

> From: Tom de Vries <tdevries@suse.de>

> 

> The "automatic symbol index cache" entry in the docs is missing entries in the

> concept and command indices.  Add them.


Thanks for catching this.

> OK for trunk?


Yes, with one comment:

> +@kindex set index-cache on

>  @item set index-cache on

> +@kindex set index-cache off

>  @itemx set index-cache off

>  Enable or disable the use of the symbol index cache.

>  

> +@kindex set index-cache directory

>  @item set index-cache directory @var{directory}

> +@kindex show index-cache directory

>  @itemx show index-cache directory

>  Set/show the directory where index files will be saved.

>  

> @@ -20432,6 +20437,7 @@ differ according to local convention.

>  There is no limit on the disk space used by index cache.  It is perfectly safe

>  to delete the content of that directory to free up disk space.

>  

> +@kindex show index-cache stats

>  @item show index-cache stats

>  Print the number of cache hits and misses since the launch of @value{GDBN}.


You have here 4 index entries that all begin with the same string and
all point to places very close to one another in the manual (in the
printed version, they will all point to the same page number).  This
is not useful, so I suggest just two index entries:

  @kindex set index-cache
  @kindex show index-cache

Thanks.

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 0774181ac5..35c87ecde9 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -20407,6 +20407,7 @@  currently work for programs using Ada.
 
 @subsection Automatic symbol index cache
 
+@cindex automatic symbol index cache
 It is possible for @value{GDBN} to automatically save a copy of this index in a
 cache on disk and retrieve it from there when loading the same binary in the
 future.  This feature can be turned on with @kbd{set index-cache on}.  The
@@ -20414,11 +20415,15 @@  following commands can be used to tweak the behavior of the index cache.
 
 @table @code
 
+@kindex set index-cache on
 @item set index-cache on
+@kindex set index-cache off
 @itemx set index-cache off
 Enable or disable the use of the symbol index cache.
 
+@kindex set index-cache directory
 @item set index-cache directory @var{directory}
+@kindex show index-cache directory
 @itemx show index-cache directory
 Set/show the directory where index files will be saved.
 
@@ -20432,6 +20437,7 @@  differ according to local convention.
 There is no limit on the disk space used by index cache.  It is perfectly safe
 to delete the content of that directory to free up disk space.
 
+@kindex show index-cache stats
 @item show index-cache stats
 Print the number of cache hits and misses since the launch of @value{GDBN}.