diff options
| author |   Quentin Schulz <foss+yocto@0leil.net> | 2023-06-22 18:48:45 +0200 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-06-24 12:22:23 +0100 |
| commit | 7290a9daf1707ab5b2288f34353f499f5ce57d6a (patch) | |
| tree | b8eafb6d59a5290868eb28e22f9c61edb1044888 | |
| parent | 0556c7bdc82cf665faa141989f2e07dd59517735 (diff) | |
| download | bitbake-contrib-7290a9daf1707ab5b2288f34353f499f5ce57d6a.tar.gz | |
docs: bitbake-user-manual: bitbake-user-manual-hello: add links and highlights for variables
Some variables are described in the glossary so add a term role to the
references. For the others, highlight them by surrounding them with
two backticks.
Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | doc/bitbake-user-manual/bitbake-user-manual-hello.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-hello.rst b/doc/bitbake-user-manual/bitbake-user-manual-hello.rst index c8251d2a0..654196ca2 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-hello.rst +++ b/doc/bitbake-user-manual/bitbake-user-manual-hello.rst @@ -209,12 +209,12 @@ Following is the complete "Hello World" example. .. note:: - Without a value for PN , the variables STAMP , T , and B , prevent more - than one recipe from working. You can fix this by either setting PN to + Without a value for :term:`PN`, the variables :term:`STAMP`, :term:`T`, and :term:`B`, prevent more + than one recipe from working. You can fix this by either setting :term:`PN` to have a value similar to what OpenEmbedded and BitBake use in the default - bitbake.conf file (see previous example). Or, by manually updating each - recipe to set PN . You will also need to include PN as part of the STAMP - , T , and B variable definitions in the local.conf file. + ``bitbake.conf`` file (see previous example). Or, by manually updating each + recipe to set :term:`PN`. You will also need to include :term:`PN` as part of the :term:`STAMP`, + :term:`T`, and :term:`B` variable definitions in the ``local.conf`` file. The ``TMPDIR`` variable establishes a directory that BitBake uses for build output and intermediate files other than the cached @@ -319,9 +319,9 @@ Following is the complete "Hello World" example. .. note:: - We are setting both LAYERSERIES_CORENAMES and LAYERSERIES_COMPAT in this particular case, because we + We are setting both ``LAYERSERIES_CORENAMES`` and :term:`LAYERSERIES_COMPAT` in this particular case, because we are using bitbake without OpenEmbedded. - You should usually just use LAYERSERIES_COMPAT to specify the OE-Core versions for which your layer + You should usually just use :term:`LAYERSERIES_COMPAT` to specify the OE-Core versions for which your layer is compatible, and add the meta-openembedded layer to your project. You need to create the recipe file next. Inside your layer at the |