overview-manual: Clean up warnings for sphinx
PATCH 1/1 overview-manual: Clean up warnings for sphinx
--- .../overview-manual/overview-manual-concepts.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-)
documentation/overview-manual/overview-manual-concepts.rst +6 -7
@@ -251,7 +251,7 @@ if versions do not already exist in the Build Directory at the time you source the build environment setup script. Because the Poky repository is fundamentally an aggregation of existing -repositories, some users might be familiar with running the ```` script +repositories, some users might be familiar with running the "script" in the context of separate :term:`OpenEmbedded-Core (OE-Core)` and BitBake repositories rather than a single Poky repository. This discussion
@@ -382,10 +382,10 @@ In general, three types of layer input exists. You can see them below the "User Configuration" box in the `general workflow figure <#general-workflow-figure>`__: -- *Metadata (``.bb`` + Patches):* Software layers containing +- *Metadata (".bb" + Patches):* Software layers containing user-supplied recipe files, patches, and append files. A good example of a software layer might be the - ```meta-qt5`https://github.com/meta-qt5/meta-qt5 layer from + `meta-qt5`https://github.com/meta-qt5/meta-qt5 layer from the `OpenEmbedded Layer Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__. This layer is for version 5.0 of the popular
@@ -704,8 +704,7 @@ architecture are placed in ``build/tmp/deploy/ipk/qemux86``. .. _bitbake-dev-environment: -BitBake -------- +=, BitBake The OpenEmbedded build system uses :term:`BitBake` to produce images and
@@ -1143,9 +1142,9 @@ the extensible SDK (eSDK): Like image generation, the SDK script process consists of several stages and depends on many variables. The -:ref:`ref-tasks-populate_sdk` +`ref-tasks-populate_sdk` and -:ref:`ref-tasks-populate_sdk_ext` +`ref-tasks-populate_sdk_ext` tasks use these key variables to help create the list of packages to actually install. For information on the variables listed in the figure, see the "`Application Development SDK <#sdk-dev-environment>`__"
Signature · 1 line
2.17.1
hi Armin!
thanks for trying out the Sphinx docs!
Quoted 16 lines · akuster
Signed-off-by Armin Kuster <[email protected]>--- .../overview-manual/overview-manual-concepts.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-)documentation/overview-manual/overview-manual-concepts.rst +0
-0@@ -251,7 +251,7 @@ if versions do not already exist in the BuildDirectory at the time you
source the build environment setup script.Because the Poky repository is fundamentally an aggregation of existing
documentation/overview-manual/overview-manual-concepts.rst if versions do not already exist in the Build Directory at the time you · line 254
Quoted 2 lines
documentation/overview-manual/overview-manual-concepts.rst +1
-1-repositories, some users might be familiar with running the ```` script +repositories, some users might be familiar with running the "script"
This is not the proper fix. This is a weird artifact of the pandoc migration.. if you look at the original XML you will see:
<para>
Because the Poky repository is fundamentally an aggregation
of
existing repositories, some users might be familiar with
running the <filename>&OE_INIT_FILE;</filename> script
in the context of separate
<ulink
url='&YOCTO_DOCS_REF_URL;#oe-core'>OpenEmbedded-Core</ulink>
and BitBake repositories rather than a single Poky
repository.
This discussion assumes the script is executed from
within a cloned or unpacked version of Poky.
</para>
Because pandoc does not understand the &XXX; notation, it ends up with an 'empty' string in verbatim mode, so : ````. So the right fix here is to replace ```` with the link to this section:
https://docs.yoctoproject.org/ref-manual/ref-structure.html#oe-init-build-env
e.g. :ref:ref-manual/ref-structure:\\oe-init-build-env\\``
in the context of separate
Quoted 12 lines
:term:
OpenEmbedded-Core (OE-Core)and BitBake repositories rather than a single Poky repository. This discussiondocumentation/overview-manual/overview-manual-concepts.rst +0
-0@@ -382,10 +382,10 @@ In general, three types of layer input exists. Youcan see them below
the "User Configuration" box in thegeneral workflow figure <#general-workflow-figure>__:-- *Metadata (``.bb`` + Patches):* Software layers containing +- *Metadata (".bb" + Patches):* Software layers containing
user-supplied recipe files, patches, and append files. A good example of a software layer might be the
documentation/overview-manual/overview-manual-concepts.rst In general, three types of layer input exists. You can see them below · line 388
Quoted 2 lines
documentation/overview-manual/overview-manual-concepts.rst +1
-1- ```meta-qt5`https://github.com/meta-qt5/meta-qt5 layer from + `meta-qt5`https://github.com/meta-qt5/meta-qt5 layer from
hmm. did that produce the right link? I would expect
meta-qt5 <https://github.com/meta-qt5/meta-qt5>__
the `OpenEmbedded Layer
Quoted 6 lines
Index <http://layers.openembedded.org/layerindex/branch/master/layers/
Quoted 1 line
`__.
This layer is for version 5.0 of the popular
documentation/overview-manual/overview-manual-concepts.rst +0
-0@@ -704,8 +704,7 @@ architecture are placed in``build/tmp/deploy/ipk/qemux86``.
Quoted 6 lines
.. _bitbake-dev-environment:
-BitBake
--------
+=, BitBake
what is this change?
documentation/overview-manual/overview-manual-concepts.rst the extensible SDK (eSDK): · line 1146
Quoted 10 lines
The OpenEmbedded build system uses
:term:BitBaketo produce images anddocumentation/overview-manual/overview-manual-concepts.rst +1
-1@@ -1143,9 +1142,9 @@ the extensible SDK (eSDK): Like image generation, the SDK script process consists of several stages and depends on many variables. The -:ref:`ref-tasks-populate_sdk` +`ref-tasks-populate_sdk`
I think this change was not needed (e.g. the link is already the right one). It's a link to a label in another doc, so :ref: is right here.
documentation/overview-manual/overview-manual-concepts.rst the extensible SDK (eSDK):
Quoted 4 lines
documentation/overview-manual/overview-manual-concepts.rst +1
-1and -:ref:`ref-tasks-populate_sdk_ext` +`ref-tasks-populate_sdk_ext`
Right, here, it's a link to a label which doesn't seem to exist. Looking a bit closer.. it doesn't exist in the DocBook XML files themselves, so it's a bug in the docbook xml file! If you look at the manual it has the following link:
https://www.yoctoproject.org/docs/3.1.2/ref-manual/ref-manual.html#ref-tasks-populate_sdk_ext
which does not exist..
tasks use these key variables to help create the list of packages to
Quoted 7 lines
documentation/overview-manual/overview-manual-concepts.rst +0
-0actually install. For information on the variables listed in the figure,see the "
Application Development SDK <#sdk-dev-environment>__"
--
2.17.1