From: Yao Qi <yao@codesourcery.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: <gdb-patches@sourceware.org>
Subject: Re: [PATCH 04/10] Don't stress 'remote' in "Data Caching" in doc
Date: Wed, 20 Nov 2013 03:58:00 -0000 [thread overview]
Message-ID: <528C304F.4080304@codesourcery.com> (raw)
In-Reply-To: <83k3gpa0hf.fsf@gnu.org>
On 11/04/2013 12:55 AM, Eli Zaretskii wrote:
> Please don't use @ref as if it were an HTML hyperlink. The results
> look awkward in certain formats (this one will look awkward in Info).
> Instead, please say something like
>
> Such caching generally improves performance in remote debugging
> (@pxref{Remote Debugging}).
>
Fixed.
>> >-Show maximum number of dcache entries. See also @ref{Caching Remote Data, info dcache}.
>> >+Show maximum number of dcache entries. See also @ref{Caching Target Data, info dcache}.
> Likewise. Here, I would simply use @xref:
>
> @xref{Caching Target Data, info dcache}.
>
Fixed.
>> > @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. See also @ref{Caching Target Data, info dcache}.
> This cross-reference is simply redundant (you just have it in the
> previous sentence), and should be removed.
>
OK.
> OK with those changes.
Patch below is what I committed. Thanks for the review.
--
Yao (é½å°§)
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 | 6 ++++++
gdb/doc/gdb.texinfo | 31 ++++++++++++++++---------------
2 files changed, 22 insertions(+), 15 deletions(-)
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 53bb973..9b641e6 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -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
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 19e9aa5..7ec16dd 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -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
--
1.7.7.6
next prev parent reply other threads:[~2013-11-20 3:47 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-11-03 5:57 [PATCH 00/10 V2] Cache code access for disassemble Yao Qi
2013-11-03 5:56 ` [PATCH 07/10] Associate target_dcache to address_space Yao Qi
2013-11-03 16:48 ` Eli Zaretskii
2013-11-17 21:22 ` Doug Evans
2013-11-20 7:54 ` Yao Qi
2013-11-20 13:23 ` Yao Qi
2013-11-03 5:56 ` [PATCH 02/10] Don't update target_dcache if it is not initialized Yao Qi
2013-11-17 20:09 ` Doug Evans
2013-11-03 5:56 ` [PATCH 05/10] Invalidate or shrink dcache when setting is changed Yao Qi
2013-11-03 16:50 ` Eli Zaretskii
2013-11-17 20:55 ` Doug Evans
2013-11-18 14:31 ` Yao Qi
2013-11-18 15:59 ` Pedro Alves
2013-11-19 6:16 ` Yao Qi
2013-11-19 11:52 ` Pedro Alves
2013-11-19 13:12 ` Yao Qi
2013-11-03 5:56 ` [PATCH 09/10] set/show code-cache Yao Qi
2013-11-03 16:58 ` Eli Zaretskii
2013-11-18 8:23 ` Doug Evans
2013-11-03 5:56 ` [PATCH 08/10] Don't invalidate dcache when option stack-cache is changed Yao Qi
2013-11-17 22:02 ` Doug Evans
2013-11-18 14:12 ` Yao Qi
2013-11-18 15:51 ` Pedro Alves
2013-11-19 6:43 ` Yao Qi
2013-11-19 12:14 ` Pedro Alves
2013-11-19 14:06 ` Yao Qi
2013-11-03 5:56 ` [PATCH 03/10] Move target-dcache out of target.c Yao Qi
2013-11-17 20:15 ` Doug Evans
2013-11-18 15:53 ` Pedro Alves
2013-11-03 5:56 ` [PATCH 01/10] Remove last_cache Yao Qi
2013-11-17 19:52 ` Doug Evans
2013-11-03 5:57 ` [PATCH 04/10] Don't stress 'remote' in "Data Caching" in doc Yao Qi
2013-11-03 16:55 ` Eli Zaretskii
2013-11-06 7:56 ` Yao Qi
2013-11-06 10:28 ` Eli Zaretskii
2013-11-17 20:34 ` Doug Evans
2013-11-17 21:44 ` Eli Zaretskii
2013-11-20 2:41 ` Doug Evans
2013-11-20 4:01 ` Eli Zaretskii
2013-11-22 1:17 ` Doug Evans
2013-11-20 3:58 ` Yao Qi [this message]
2013-11-03 5:57 ` [PATCH 06/10] Add REGISTRY for struct address_space Yao Qi
2013-11-17 21:09 ` Doug Evans
2013-11-20 4:46 ` Yao Qi
2013-11-11 9:38 ` [PATCH 00/10 V2] Cache code access for disassemble Yao Qi
2013-11-17 17:03 ` Yao Qi
2013-11-18 8:39 ` [PATCH 10/10] Use target_read_code in disassemble Yao Qi
2013-11-18 17:12 ` Doug Evans
2013-11-20 4:46 ` [PATCH 00/10 V2] Cache code access for disassemble Yao Qi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=528C304F.4080304@codesourcery.com \
--to=yao@codesourcery.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox