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-kickstart.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-kickstart.rst')
| -rw-r--r-- | documentation/ref-manual/ref-kickstart.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst index 599e38080c..5f8c834f33 100644 --- a/documentation/ref-manual/ref-kickstart.rst +++ b/documentation/ref-manual/ref-kickstart.rst | |||
| @@ -167,7 +167,7 @@ the ``part`` and ``partition`` commands: | |||
| 167 | 167 | ||
| 168 | - *``--fsuuid``:* This option is a Wic-specific option that specifies | 168 | - *``--fsuuid``:* This option is a Wic-specific option that specifies |
| 169 | the filesystem UUID. You can generate or modify | 169 | the filesystem UUID. You can generate or modify |
| 170 | ```WKS_FILE`` <#var-WKS_FILE>`__ with this option if a preconfigured | 170 | :term:`WKS_FILE` with this option if a preconfigured |
| 171 | filesystem UUID is added to the kernel command line in the bootloader | 171 | filesystem UUID is added to the kernel command line in the bootloader |
| 172 | configuration before you run Wic. | 172 | configuration before you run Wic. |
| 173 | 173 | ||
