Re: [PATCH 04/10] Don't stress 'remote' in "Data Caching" in doc

Eli Zaretskii
2013-11-03T16:55:58Z

> From: Yao Qi <yao@codesourcery.com>
> 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.