From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 3075 invoked by alias); 3 Nov 2013 16:55:58 -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 3059 invoked by uid 89); 3 Nov 2013 16:55:57 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.8 required=5.0 tests=AWL,BAYES_00,RDNS_NONE,SPF_SOFTFAIL,URIBL_BLOCKED autolearn=no version=3.3.2 X-HELO: mtaout22.012.net.il Received: from Unknown (HELO mtaout22.012.net.il) (80.179.55.172) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Sun, 03 Nov 2013 16:55:56 +0000 Received: from conversion-daemon.a-mtaout22.012.net.il by a-mtaout22.012.net.il (HyperSendmail v2007.08) id <0MVP00J005M93J00@a-mtaout22.012.net.il> for gdb-patches@sourceware.org; Sun, 03 Nov 2013 18:55:47 +0200 (IST) Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout22.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MVP00II75OZUW70@a-mtaout22.012.net.il>; Sun, 03 Nov 2013 18:55:47 +0200 (IST) Date: Sun, 03 Nov 2013 16:55:00 -0000 From: Eli Zaretskii Subject: Re: [PATCH 04/10] Don't stress 'remote' in "Data Caching" in doc In-reply-to: <1383458049-20893-5-git-send-email-yao@codesourcery.com> To: Yao Qi Cc: gdb-patches@sourceware.org Reply-to: Eli Zaretskii Message-id: <83k3gpa0hf.fsf@gnu.org> References: <1383458049-20893-1-git-send-email-yao@codesourcery.com> <1383458049-20893-5-git-send-email-yao@codesourcery.com> X-IsSubscribed: yes X-SW-Source: 2013-11/txt/msg00044.txt.bz2 > From: Yao Qi > Date: Sun, 3 Nov 2013 13:54:04 +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 caches target data, > instead of remote data. Thanks. But may I ask in the future not to split the patches to documentation that are related to the same series? When you split them, it makes the review harder, as I see the documentation changes piecemeal, rather than together. > +@value{GDBN} caches data exchanged between the debugger and a target. > +Such caching generally improves performance in @ref{Remote Debugging}, 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}). > -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}. > @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 with those changes.