diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-24 16:27:54 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | c473fa229239752367c5d573160fc8738cf1907e (patch) | |
tree | f8520ba3aa3cf911333dbd31e38e9a52203a0285 /documentation/ref-manual/ref-release-process.rst | |
parent | 4cd953989de42c7a83f666c23e077d53b016a1f1 (diff) | |
download | poky-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/ref-manual/ref-release-process.rst')
-rw-r--r-- | documentation/ref-manual/ref-release-process.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index c09fd7a075..95ec686a13 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst | |||
@@ -41,7 +41,7 @@ Major Release Codenames | |||
41 | Each major release receives a codename that identifies the release in | 41 | Each major release receives a codename that identifies the release in |
42 | the `Yocto Project Source | 42 | the `Yocto Project Source |
43 | Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__. The | 43 | Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__. The |
44 | concept is that branches of `Metadata <#metadata>`__ with the same | 44 | concept is that branches of :term:`Metadata` with the same |
45 | codename are likely to be compatible and thus work together. | 45 | codename are likely to be compatible and thus work together. |
46 | 46 | ||
47 | .. note:: | 47 | .. note:: |
@@ -107,12 +107,12 @@ consists of the following pieces: | |||
107 | - ``bitbake-selftest``: A standalone command that runs unit tests on | 107 | - ``bitbake-selftest``: A standalone command that runs unit tests on |
108 | key pieces of BitBake and its fetchers. | 108 | key pieces of BitBake and its fetchers. |
109 | 109 | ||
110 | - ```sanity.bbclass`` <#ref-classes-sanity>`__: This automatically | 110 | - :ref:`sanity.bbclass <ref-classes-sanity>`: This automatically |
111 | included class checks the build environment for missing tools (e.g. | 111 | included class checks the build environment for missing tools (e.g. |
112 | ``gcc``) or common misconfigurations such as | 112 | ``gcc``) or common misconfigurations such as |
113 | ```MACHINE`` <#var-MACHINE>`__ set incorrectly. | 113 | :term:`MACHINE` set incorrectly. |
114 | 114 | ||
115 | - ```insane.bbclass`` <#ref-classes-insane>`__: This class checks the | 115 | - :ref:`insane.bbclass <ref-classes-insane>`: This class checks the |
116 | generated output from builds for sanity. For example, if building for | 116 | generated output from builds for sanity. For example, if building for |
117 | an ARM target, did the build produce ARM binaries. If, for example, | 117 | an ARM target, did the build produce ARM binaries. If, for example, |
118 | the build produced PPC binaries then there is a problem. | 118 | the build produced PPC binaries then there is a problem. |
@@ -149,7 +149,7 @@ efficiently. | |||
149 | 149 | ||
150 | The Yocto Project's main Autobuilder (``autobuilder.yoctoproject.org``) | 150 | The Yocto Project's main Autobuilder (``autobuilder.yoctoproject.org``) |
151 | publicly tests each Yocto Project release's code in the | 151 | publicly tests each Yocto Project release's code in the |
152 | `OE-Core <#oe-core>`__, Poky, and BitBake repositories. The testing | 152 | :term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing |
153 | occurs for both the current state of the "master" branch and also for | 153 | occurs for both the current state of the "master" branch and also for |
154 | submitted patches. Testing for submitted patches usually occurs in the | 154 | submitted patches. Testing for submitted patches usually occurs in the |
155 | "ross/mut" branch in the ``poky-contrib`` repository (i.e. the | 155 | "ross/mut" branch in the ``poky-contrib`` repository (i.e. the |