Don't stress 'remote' in "Data Caching" in doc
authorYao Qi <yao@codesourcery.com>
Thu, 31 Oct 2013 12:49:49 +0000 (20:49 +0800)
committerYao Qi <yao@codesourcery.com>
Wed, 20 Nov 2013 03:40:55 +0000 (11:40 +0800)
When I try to describe the cache and its related commands (in a
cache-per-address-space world), I find hard to add, because
existing doc is focused on remote debugging, while data cache is used
regardless of the target.  More precisely, GDB cache target data,
instead of remote data.

gdb/doc:

2013-11-20  Yao Qi  <yao@codesourcery.com>

* gdb.texinfo (Data): Rename menu item.
(Caching Remote Data): Rename to ...
(Caching Target Data): ... it.  Update.

gdb/doc/ChangeLog
gdb/doc/gdb.texinfo

index 53bb973b7546c6c1bb9d70ec4d2ca4e63c0f3be7..9b641e612e89c4666bf469bfc1f544b49ab3be5a 100644 (file)
@@ -1,3 +1,9 @@
+2013-11-20  Yao Qi  <yao@codesourcery.com>
+
+       * gdb.texinfo (Data): Rename menu item.
+       (Caching Remote Data): Rename to ...
+       (Caching Target Data): ... it.  Update.
+
 2013-11-18  Joel Brobecker  <brobecker@adacore.com>
 
        * gdb.texinfo (GDB/MI Miscellaneous Commands): Document the new
index 19e9aa54e056e62f763467a81307f9c4693a0a9c..7ec16dd184cbfc8ede391391cee75458a7691cb5 100644 (file)
@@ -8066,7 +8066,7 @@ being passed the type of @var{arg} as the argument.
 * Core File Generation::        Cause a program dump its core
 * Character Sets::              Debugging programs that use a different
                                 character set than GDB does
-* Caching Remote Data::         Data caching for remote targets
+* Caching Target Data::         Data caching for targets
 * Searching Memory::            Searching memory for a sequence of bytes
 @end menu
 
@@ -10823,18 +10823,19 @@ $10 = 78 '+'
 The @sc{ibm1047} character set uses the number 78 to encode the @samp{+}
 character.
 
-@node Caching Remote Data
-@section Caching Data of Remote Targets
-@cindex caching data of remote targets
-
-@value{GDBN} caches data exchanged between the debugger and a
-remote target (@pxref{Remote Debugging}).  Such caching generally improves
-performance, because it reduces the overhead of the remote protocol by
-bundling memory reads and writes into large chunks.  Unfortunately, simply
-caching everything would lead to incorrect results, since @value{GDBN} 
-does not necessarily know anything about volatile values, memory-mapped I/O
-addresses, etc.  Furthermore, in non-stop mode (@pxref{Non-Stop Mode})
-memory can be changed @emph{while} a gdb command is executing.
+@node Caching Target Data
+@section Caching Data of Targets
+@cindex caching data of targets
+
+@value{GDBN} caches data exchanged between the debugger and a target.
+Such caching generally improves performance in remote debugging
+(@pxref{Remote Debugging}), because it reduces the overhead of the
+remote protocol by bundling memory reads and writes into large chunks.
+Unfortunately, simply caching everything would lead to incorrect results,
+since @value{GDBN} does not necessarily know anything about volatile
+values, memory-mapped I/O addresses, etc.  Furthermore, in non-stop mode
+(@pxref{Non-Stop Mode}) memory can be changed @emph{while} a gdb command
+is executing.
 Therefore, by default, @value{GDBN} only caches data
 known to be on the stack@footnote{In non-stop mode, it is moderately
 rare for a running thread to modify the stack of a stopped thread
@@ -10888,11 +10889,11 @@ Must be a power of 2.
 
 @item show dcache size
 @kindex show dcache size
-Show maximum number of dcache entries.  See also @ref{Caching Remote Data, info dcache}.
+Show maximum number of dcache entries.  @xref{Caching Target Data, info dcache}.
 
 @item show dcache line-size
 @kindex show dcache line-size
-Show default size of dcache lines.  See also @ref{Caching Remote Data, info dcache}.
+Show default size of dcache lines.
 
 @end table