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/ref-manual/ref-devtool-reference.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'documentation/ref-manual/ref-devtool-reference.rst') diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index 5bb1a64d99..b0c4bcc7a0 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst @@ -217,7 +217,7 @@ Git, checks out a branch for development, and applies any patches from the recipe as commits on top. You can use the following command to checkout the source files: $ devtool modify recipe Using the above command form, ``devtool`` uses the existing recipe's -```SRC_URI`` <#var-SRC_URI>`__ statement to locate the upstream source, +:term:`SRC_URI` statement to locate the upstream source, extracts the source into the default sources location in the workspace. The default development branch used is "devtool". @@ -360,9 +360,9 @@ When you use the ``devtool upgrade`` command, you must supply the root name of the recipe (i.e. no version, paths, or extensions), and you must supply the directory to which you want the source extracted. Additional command options let you control things such as the version number to -which you want to upgrade (i.e. the ```PV`` <#var-PV>`__), the source +which you want to upgrade (i.e. the :term:`PV`), the source revision to which you want to upgrade (i.e. the -```SRCREV`` <#var-SRCREV>`__), whether or not to apply patches, and so +:term:`SRCREV`), whether or not to apply patches, and so forth. You can read more on the ``devtool upgrade`` workflow in the "`Use @@ -439,7 +439,7 @@ The target is the address of the target machine, which must be running an SSH server (i.e. ``user@hostname[:destdir]``). This command deploys all files installed during the -```do_install`` <#ref-tasks-install>`__ task. Furthermore, you do not +:ref:`ref-tasks-install` task. Furthermore, you do not need to have package management enabled within the target machine. If you do, the package manager is bypassed. @@ -492,7 +492,7 @@ Creating the Workspace Layer in an Alternative Location ======================================================= Use the ``devtool create-workspace`` command to create a new workspace -layer in your `Build Directory <#build-directory>`__. When you create a +layer in your :term:`Build Directory`. When you create a new workspace layer, it is populated with the ``README`` file and the ``conf`` directory only. -- cgit v1.2.3-54-g00ecf