From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 18386 invoked by alias); 20 Nov 2013 03:47:15 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 18362 invoked by uid 89); 20 Nov 2013 03:47:14 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=3.1 required=5.0 tests=AWL,BAYES_50,GARBLED_BODY,RDNS_NONE,URIBL_BLOCKED autolearn=no version=3.3.2 X-HELO: relay1.mentorg.com Received: from Unknown (HELO relay1.mentorg.com) (192.94.38.131) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Wed, 20 Nov 2013 03:47:13 +0000 Received: from svr-orw-fem-01.mgc.mentorg.com ([147.34.98.93]) by relay1.mentorg.com with esmtp id 1Viyki-0000CG-9Y from Yao_Qi@mentor.com ; Tue, 19 Nov 2013 19:46:56 -0800 Received: from SVR-ORW-FEM-02.mgc.mentorg.com ([147.34.96.206]) by svr-orw-fem-01.mgc.mentorg.com over TLS secured channel with Microsoft SMTPSVC(6.0.3790.4675); Tue, 19 Nov 2013 19:46:56 -0800 Received: from qiyao.dyndns.org (147.34.91.1) by svr-orw-fem-02.mgc.mentorg.com (147.34.96.168) with Microsoft SMTP Server id 14.2.247.3; Tue, 19 Nov 2013 19:46:55 -0800 Message-ID: <528C304F.4080304@codesourcery.com> Date: Wed, 20 Nov 2013 03:58:00 -0000 From: Yao Qi User-Agent: Mozilla/5.0 (X11; Linux i686; rv:17.0) Gecko/20130110 Thunderbird/17.0.2 MIME-Version: 1.0 To: Eli Zaretskii CC: Subject: Re: [PATCH 04/10] Don't stress 'remote' in "Data Caching" in doc References: <1383458049-20893-1-git-send-email-yao@codesourcery.com> <1383458049-20893-5-git-send-email-yao@codesourcery.com> <83k3gpa0hf.fsf@gnu.org> In-Reply-To: <83k3gpa0hf.fsf@gnu.org> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-IsSubscribed: yes X-SW-Source: 2013-11/txt/msg00581.txt.bz2 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 * 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 + + * gdb.texinfo (Data): Rename menu item. + (Caching Remote Data): Rename to ... + (Caching Target Data): ... it. Update. + 2013-11-18 Joel Brobecker * 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