linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Peter Oberparleiter <oberpar@linux.ibm.com>
To: Wu XiangCheng <bobwxc@email.cn>
Cc: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs/gcov: Convert two tags to ref in dev-tools/gov.rst
Date: Wed, 7 Apr 2021 16:16:33 +0200	[thread overview]
Message-ID: <75131ef2-2c6f-3fc4-8a79-bab0d0f7b633@linux.ibm.com> (raw)
In-Reply-To: <20210403113752.GA32236@mipc>

On 03.04.2021 13:37, Wu XiangCheng wrote:
> Htmldocs does not display the chapter number, convert the two manual
> chapter number tags to ref tags.
> 
> Signed-off-by: Wu XiangCheng <bobwxc@email.cn>

Looks sane to me.

Acked-by: Peter Oberparleiter <oberpar@linux.ibm.com>

Unfortunately I don't know how documentation updates such as this one
are typically handled...

> ---
>  Documentation/dev-tools/gcov.rst | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/dev-tools/gcov.rst b/Documentation/dev-tools/gcov.rst
> index 9e989baae154..5fce2b06f229 100644
> --- a/Documentation/dev-tools/gcov.rst
> +++ b/Documentation/dev-tools/gcov.rst
> @@ -124,6 +124,8 @@ box for setups where kernels are built and run on the same machine. In
>  cases where the kernel runs on a separate machine, special preparations
>  must be made, depending on where the gcov tool is used:
>  
> +.. _gcov-test:
> +
>  a) gcov is run on the TEST machine
>  
>      The gcov tool version on the test machine must be compatible with the
> @@ -143,6 +145,8 @@ a) gcov is run on the TEST machine
>      machine. If any of the path components is symbolic link, the actual
>      directory needs to be used instead (due to make's CURDIR handling).
>  
> +.. _gcov-build:
> +
>  b) gcov is run on the BUILD machine
>  
>      The following files need to be copied after each test case from test
> @@ -211,7 +215,7 @@ Appendix A: gather_on_build.sh
>  ------------------------------
>  
>  Sample script to gather coverage meta files on the build machine
> -(see 6a):
> +(see :ref:`Separated build and test machines a. <gcov-test>`):
>  
>  .. code-block:: sh
>  
> @@ -244,7 +248,7 @@ Appendix B: gather_on_test.sh
>  -----------------------------
>  
>  Sample script to gather coverage data files on the test machine
> -(see 6b):
> +(see :ref:`Separated build and test machines b. <gcov-build>`):
>  
>  .. code-block:: sh
>  
> 


-- 
Peter Oberparleiter
Linux on Z Development - IBM Germany

  reply	other threads:[~2021-04-07 14:16 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-03 11:37 [PATCH] docs/gcov: Convert two tags to ref in dev-tools/gov.rst Wu XiangCheng
2021-04-07 14:16 ` Peter Oberparleiter [this message]
2021-04-08 17:20   ` Jonathan Corbet

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=75131ef2-2c6f-3fc4-8a79-bab0d0f7b633@linux.ibm.com \
    --to=oberpar@linux.ibm.com \
    --cc=bobwxc@email.cn \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).