From c473fa229239752367c5d573160fc8738cf1907e Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Fri, 24 Jul 2020 16:27:54 +0200 Subject: 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 `", line) line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\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 Signed-off-by: Richard Purdie --- documentation/test-manual/test-manual-intro.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'documentation/test-manual') 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 thefollowing types of tests: - *Build Testing:* Tests whether specific configurations build by - varying ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__, - ```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__, other configuration + varying :term:`MACHINE`, + :term:`DISTRO`, other configuration options, and the specific target images being built (or world). Used to trigger builds of all the different test configurations on the Autobuilder. Builds usually cover many different targets for @@ -105,7 +105,7 @@ thefollowing types of tests: Autobuilder tests literally hundreds of configurations and targets. - *Sanity Checks During the Build Process:* Tests initiated through - the ```insane`` <&YOCTO_DOCS_REF_URL;#ref-classes-insane>`__ + the :ref:`insane ` class. These checks ensure the output of the builds are correct. For example, does the ELF architecture in the generated binaries match the target system? ARM binaries would not work in a MIPS @@ -133,9 +133,9 @@ thefollowing types of tests: - *Image Testing:* Image tests initiated through the following command: $ bitbake image -c testimage The tests utilize the - ```testimage*`` <&YOCTO_DOCS_REF_URL;#ref-classes-testimage*>`__ + :ref:`testimage* ` classes and the - ```do_testimage`` <&YOCTO_DOCS_REF_URL;#ref-tasks-testimage>`__ task. + :ref:`ref-tasks-testimage` task. - *Layer Testing:* The Autobuilder has the possibility to test whether specific layers work with the test of the system. The layers tested @@ -152,7 +152,7 @@ thefollowing types of tests: - *SDK Testing:* Image tests initiated through the following command: $ bitbake image -c testsdk The tests utilize the - ```testsdk`` <&YOCTO_DOCS_REF_URL;#ref-classes-testsdk>`__ class and + :ref:`testsdk ` class and the ``do_testsdk`` task. - *Unit Testing:* Unit tests on various components of the system run @@ -236,7 +236,7 @@ Tests map into the codebase as follows: ``meta/lib/oeqa/runtime/cases/``. - You need to set the - ```IMAGE_CLASSES`` <&YOCTO_DOCS_REF_URL;#var-IMAGE_CLASSES>`__ + :term:`IMAGE_CLASSES` variable as follows: IMAGE_CLASSES += "testimage" - Run the tests using the following command form: $ bitbake image -c -- cgit v1.2.3-54-g00ecf