Skip to contentSkip to conversation

docs/gcov: Convert two tags to ref in dev-tools/gov.rst

PATCH In review Wu XiangCheng 3 participants 3 messages Apr 3, 2021 – Apr 8, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/gcov: Convert two tags to ref in dev-tools/gov.rst

Htmldocs does not display the chapter number, convert the two manual chapter number tags to ref tags.

---
 Documentation/dev-tools/gcov.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
Documentation/dev-tools/gcov.rst +6 -2
index 9e989baae154..5fce2b06f229 100644
@@ -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
 
Signature · 1 line
2.20.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 4 lines · Wu XiangCheng

Htmldocs does not display the chapter number, convert the two manual chapter number tags to ref tags.

Looks sane to me.

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

Quoted 45 lines
---
 Documentation/dev-tools/gcov.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
Documentation/dev-tools/gcov.rst +6 -2
index 9e989baae154..5fce2b06f229 100644
@@ -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
 
Signature · 2 lines
Peter Oberparleiter
Linux on Z Development - IBM Germany
maintainer
#2 lore raw
Quoted 4 lines · Peter Oberparleiter
Quoted 3 lines · Wu XiangCheng

Htmldocs does not display the chapter number, convert the two manual chapter number tags to ref tags.

Quoted 8 lines
Quoted 1 line

Looks sane to me.

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

I've applied it.

Thanks,

jon