summaryrefslogtreecommitdiffstats
path: root/documentation/test-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-24 16:27:54 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commitc473fa229239752367c5d573160fc8738cf1907e (patch)
treef8520ba3aa3cf911333dbd31e38e9a52203a0285 /documentation/test-manual
parent4cd953989de42c7a83f666c23e077d53b016a1f1 (diff)
downloadpoky-c473fa229239752367c5d573160fc8738cf1907e.tar.gz
sphinx: fix internal links
Many of the internal links were not converted probably from DocBook using pandoc. After looking at the various patterns, the follow series of 'naive' Python regexp were used to perform some additional automatic conversion. Also, since we rely on built-in glossary, all links to terms need to use the sphinx :term: syntax. This commit is generated using the following Python series of regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__", ":term:`\\1`", line) line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__", ":ref:`ref-tasks-\\1`", line) line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1.bbclass <ref-classes-\\1>`", line) line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1 <ref-classes-\\1>`", line) line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__", ":term:`Source Directory`", line) line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__", ":term:`Build Directory`", line) line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__", ":term:`Metadata`", line) line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__", ":term:`BitBake`", line) line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__", ":ref:`ref-manual/ref-images:Images`", line) line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__", ":ref:`ref-manual/ref-classes:Classes`", line) line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__", ":ref:`devtool-the-workspace-layer-structure`", line) line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__", ":term:`OpenEmbedded Build System`", line) line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__", ":term:`OpenEmbedded-Core (OE-Core)`", line) It won't catch multiline strings, but it catches a very large number of occurences! (From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/test-manual')
-rw-r--r--documentation/test-manual/test-manual-intro.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/documentation/test-manual/test-manual-intro.rst b/documentation/test-manual/test-manual-intro.rst
index a7f91e06ac..80e57b134c 100644
--- a/documentation/test-manual/test-manual-intro.rst
+++ b/documentation/test-manual/test-manual-intro.rst
@@ -95,8 +95,8 @@ The Autobuilder tests different elements of the project by using
95thefollowing types of tests: 95thefollowing types of tests:
96 96
97- *Build Testing:* Tests whether specific configurations build by 97- *Build Testing:* Tests whether specific configurations build by
98 varying ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__, 98 varying :term:`MACHINE`,
99 ```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__, other configuration 99 :term:`DISTRO`, other configuration
100 options, and the specific target images being built (or world). Used 100 options, and the specific target images being built (or world). Used
101 to trigger builds of all the different test configurations on the 101 to trigger builds of all the different test configurations on the
102 Autobuilder. Builds usually cover many different targets for 102 Autobuilder. Builds usually cover many different targets for
@@ -105,7 +105,7 @@ thefollowing types of tests:
105 Autobuilder tests literally hundreds of configurations and targets. 105 Autobuilder tests literally hundreds of configurations and targets.
106 106
107 - *Sanity Checks During the Build Process:* Tests initiated through 107 - *Sanity Checks During the Build Process:* Tests initiated through
108 the ```insane`` <&YOCTO_DOCS_REF_URL;#ref-classes-insane>`__ 108 the :ref:`insane <ref-classes-insane>`
109 class. These checks ensure the output of the builds are correct. 109 class. These checks ensure the output of the builds are correct.
110 For example, does the ELF architecture in the generated binaries 110 For example, does the ELF architecture in the generated binaries
111 match the target system? ARM binaries would not work in a MIPS 111 match the target system? ARM binaries would not work in a MIPS
@@ -133,9 +133,9 @@ thefollowing types of tests:
133 133
134- *Image Testing:* Image tests initiated through the following command: 134- *Image Testing:* Image tests initiated through the following command:
135 $ bitbake image -c testimage The tests utilize the 135 $ bitbake image -c testimage The tests utilize the
136 ```testimage*`` <&YOCTO_DOCS_REF_URL;#ref-classes-testimage*>`__ 136 :ref:`testimage* <ref-classes-testimage*>`
137 classes and the 137 classes and the
138 ```do_testimage`` <&YOCTO_DOCS_REF_URL;#ref-tasks-testimage>`__ task. 138 :ref:`ref-tasks-testimage` task.
139 139
140- *Layer Testing:* The Autobuilder has the possibility to test whether 140- *Layer Testing:* The Autobuilder has the possibility to test whether
141 specific layers work with the test of the system. The layers tested 141 specific layers work with the test of the system. The layers tested
@@ -152,7 +152,7 @@ thefollowing types of tests:
152 152
153- *SDK Testing:* Image tests initiated through the following command: $ 153- *SDK Testing:* Image tests initiated through the following command: $
154 bitbake image -c testsdk The tests utilize the 154 bitbake image -c testsdk The tests utilize the
155 ```testsdk`` <&YOCTO_DOCS_REF_URL;#ref-classes-testsdk>`__ class and 155 :ref:`testsdk <ref-classes-testsdk>` class and
156 the ``do_testsdk`` task. 156 the ``do_testsdk`` task.
157 157
158- *Unit Testing:* Unit tests on various components of the system run 158- *Unit Testing:* Unit tests on various components of the system run
@@ -236,7 +236,7 @@ Tests map into the codebase as follows:
236 ``meta/lib/oeqa/runtime/cases/``. 236 ``meta/lib/oeqa/runtime/cases/``.
237 237
238 - You need to set the 238 - You need to set the
239 ```IMAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_CLASSES>`__ 239 :term:`IMAGE_CLASSES`
240 variable as follows: IMAGE_CLASSES += "testimage" 240 variable as follows: IMAGE_CLASSES += "testimage"
241 241
242 - Run the tests using the following command form: $ bitbake image -c 242 - Run the tests using the following command form: $ bitbake image -c