summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-manual-yp-intro.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-yp-intro.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-yp-intro.rst')
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index 3f845731a0..b27412cb25 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -260,7 +260,7 @@ accomplish this through a recipe that is a BitBake append
260 Yocto Project Board Support Packages (BSP) Developer's Guide 260 Yocto Project Board Support Packages (BSP) Developer's Guide
261 . 261 .
262 262
263The `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ 263The :term:`Source Directory`
264contains both general layers and BSP layers right out of the box. You 264contains both general layers and BSP layers right out of the box. You
265can easily identify layers that ship with a Yocto Project release in the 265can easily identify layers that ship with a Yocto Project release in the
266Source Directory by their names. Layers typically have names that begin 266Source Directory by their names. Layers typically have names that begin
@@ -461,7 +461,7 @@ Open-Embedded Build System Components
461------------------------------------- 461-------------------------------------
462 462
463The following list consists of components associated with the 463The following list consists of components associated with the
464`OpenEmbedded build system <&YOCTO_DOCS_REF_URL;#build-system-term>`__: 464:term:`OpenEmbedded Build System`:
465 465
466- *BitBake:* BitBake is a core component of the Yocto Project and is 466- *BitBake:* BitBake is a core component of the Yocto Project and is
467 used by the OpenEmbedded build system to build images. While BitBake 467 used by the OpenEmbedded build system to build images. While BitBake
@@ -508,7 +508,7 @@ Reference Distribution (Poky)
508----------------------------- 508-----------------------------
509 509
510Poky is the Yocto Project reference distribution. It contains the 510Poky is the Yocto Project reference distribution. It contains the
511`Open-Embedded build system <&YOCTO_DOCS_REF_URL;#build-system-term>`__ 511:term:`OpenEmbedded Build System`
512(BitBake and OE-Core) as well as a set of metadata to get you started 512(BitBake and OE-Core) as well as a set of metadata to get you started
513building your own distribution. See the 513building your own distribution. See the
514`figure <#what-is-the-yocto-project>`__ in "What is the Yocto Project?" 514`figure <#what-is-the-yocto-project>`__ in "What is the Yocto Project?"
@@ -618,7 +618,7 @@ Project.
618- *Native Linux Host:* By far the best option for a Build Host. A 618- *Native Linux Host:* By far the best option for a Build Host. A
619 system running Linux as its native operating system allows you to 619 system running Linux as its native operating system allows you to
620 develop software by directly using the 620 develop software by directly using the
621 `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ tool. You can 621 :term:`BitBake` tool. You can
622 accomplish all aspects of development from a familiar shell of a 622 accomplish all aspects of development from a familiar shell of a
623 supported Linux distribution. 623 supported Linux distribution.
624 624
@@ -684,9 +684,9 @@ Reference Embedded Distribution (Poky)
684 684
685"Poky", which is pronounced *Pock*-ee, is the name of the Yocto 685"Poky", which is pronounced *Pock*-ee, is the name of the Yocto
686Project's reference distribution or Reference OS Kit. Poky contains the 686Project's reference distribution or Reference OS Kit. Poky contains the
687`OpenEmbedded Build System <&YOCTO_DOCS_REF_URL;#build-system-term>`__ 687:term:`OpenEmbedded Build System`
688(`BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ and 688(:term:`BitBake` and
689`OpenEmbedded-Core <&YOCTO_DOCS_REF_URL;#oe-core>`__) as well as a set 689:term:`OpenEmbedded-Core (OE-Core)`) as well as a set
690of `metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ to get you started 690of `metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ to get you started
691building your own distro. In other words, Poky is a base specification 691building your own distro. In other words, Poky is a base specification
692of the functionality needed for a typical embedded system as well as the 692of the functionality needed for a typical embedded system as well as the
@@ -923,9 +923,9 @@ helpful for getting started:
923 Another point worth noting is that historically within the Yocto 923 Another point worth noting is that historically within the Yocto
924 Project, recipes were referred to as packages - thus, the existence 924 Project, recipes were referred to as packages - thus, the existence
925 of several BitBake variables that are seemingly mis-named, (e.g. 925 of several BitBake variables that are seemingly mis-named, (e.g.
926 ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__, 926 :term:`PR`,
927 ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__, and 927 :term:`PV`, and
928 ```PE`` <&YOCTO_DOCS_REF_URL;#var-PE>`__). 928 :term:`PE`).
929 929
930- *Poky:* Poky is a reference embedded distribution and a reference 930- *Poky:* Poky is a reference embedded distribution and a reference
931 test configuration. Poky provides the following: 931 test configuration. Poky provides the following: