summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-manual-development-environment.rst
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/overview-manual/overview-manual-development-environment.rst
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/overview-manual/overview-manual-development-environment.rst')
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index d59e52c488..745d2ecf91 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -149,7 +149,7 @@ Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the
149interface, you can click on any particular item in the "Name" column and 149interface, you can click on any particular item in the "Name" column and
150see the URL at the bottom of the page that you need to clone a Git 150see the URL at the bottom of the page that you need to clone a Git
151repository for that particular item. Having a local Git repository of 151repository for that particular item. Having a local Git repository of
152the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__, which 152the :term:`Source Directory`, which
153is usually named "poky", allows you to make changes, contribute to the 153is usually named "poky", allows you to make changes, contribute to the
154history, and ultimately enhance the Yocto Project's tools, Board Support 154history, and ultimately enhance the Yocto Project's tools, Board Support
155Packages, and so forth. 155Packages, and so forth.
@@ -636,7 +636,7 @@ find information on the GNU GPL
636 636
637When you build an image using the Yocto Project, the build process uses 637When you build an image using the Yocto Project, the build process uses
638a known list of licenses to ensure compliance. You can find this list in 638a known list of licenses to ensure compliance. You can find this list in
639the `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ at 639the :term:`Source Directory` at
640``meta/files/common-licenses``. Once the build completes, the list of 640``meta/files/common-licenses``. Once the build completes, the list of
641all licenses found and used during that build are kept in the `Build 641all licenses found and used during that build are kept in the `Build
642Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ at 642Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ at
@@ -660,7 +660,7 @@ that conform to the Open Source Definition (OSD).
660 660
661You can find a list of the combined SPDX and OSI licenses that the Yocto 661You can find a list of the combined SPDX and OSI licenses that the Yocto
662Project uses in the ``meta/files/common-licenses`` directory in your 662Project uses in the ``meta/files/common-licenses`` directory in your
663`Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__. 663:term:`Source Directory`.
664 664
665For information that can help you maintain compliance with various open 665For information that can help you maintain compliance with various open
666source licensing during the lifecycle of a product created using the 666source licensing during the lifecycle of a product created using the