poky/documentation/kernel-dev
Nicolas Dechesne c473fa2292 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>
2020-09-17 10:09:33 +01:00
..
figures kernel-dev, mega-manual: kernel dev flow fig update and chapter revs 2017-09-13 18:00:19 +01:00
kernel-dev-advanced.rst sphinx: fix internal links 2020-09-17 10:09:33 +01:00
kernel-dev-advanced.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-common.rst sphinx: fix internal links 2020-09-17 10:09:33 +01:00
kernel-dev-common.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-concepts-appx.rst sphinx: fix internal links 2020-09-17 10:09:33 +01:00
kernel-dev-concepts-appx.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-customization.xsl kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-faq.rst sphinx: fix internal links 2020-09-17 10:09:33 +01:00
kernel-dev-faq.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-intro.rst sphinx: fix internal links 2020-09-17 10:09:33 +01:00
kernel-dev-intro.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-maint-appx.rst sphinx: fix internal links 2020-09-17 10:09:33 +01:00
kernel-dev-maint-appx.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev-style.css kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00
kernel-dev.rst sphinx: ref-manual: add revision history table 2020-09-17 10:09:33 +01:00
kernel-dev.xml kernel-dev: Add SPDX license headers 2020-06-17 16:45:36 +01:00