mirror of
https://git.yoctoproject.org/poky
synced 2026-05-31 00:39:46 +00:00
manuals: simplify references to the BitBake User Manual
- Replacing :ref:`bitbake:bitbake-user-manual/...` by :ref:`bitbake-user-manual/...` Adding "bitbake:" as a prefix is not necessary as there is no naming conflict between the YP and the BitBake manuals (all documents are in "bitbake-user-manual/") - Explaining the rules in the README file - When necessary, fixing line length in the modified paragraphs. (From yocto-docs rev: d80b31705450cfb98d217ea44ba2edace2d64095) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
committed by
Richard Purdie
parent
1f8322c832
commit
8355326ffa
@@ -108,7 +108,7 @@ Viewing Variable Values
|
||||
Sometimes you need to know the value of a variable as a result of
|
||||
BitBake's parsing step. This could be because some unexpected behavior
|
||||
occurred in your project. Perhaps an attempt to :ref:`modify a variable
|
||||
<bitbake:bitbake-user-manual/bitbake-user-manual-metadata:modifying existing
|
||||
<bitbake-user-manual/bitbake-user-manual-metadata:modifying existing
|
||||
variables>` did not work out as expected.
|
||||
|
||||
BitBake's ``-e`` option is used to display variable values after
|
||||
@@ -282,15 +282,14 @@ Viewing Task Variable Dependencies
|
||||
==================================
|
||||
|
||||
As mentioned in the
|
||||
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section of the BitBake
|
||||
User Manual, BitBake tries to automatically determine what variables a
|
||||
task depends on so that it can rerun the task if any values of the
|
||||
variables change. This determination is usually reliable. However, if
|
||||
you do things like construct variable names at runtime, then you might
|
||||
have to manually declare dependencies on those variables using
|
||||
``vardeps`` as described in the
|
||||
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section of the BitBake
|
||||
User Manual.
|
||||
":ref:`bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`"
|
||||
section of the BitBake User Manual, BitBake tries to automatically determine
|
||||
what variables a task depends on so that it can rerun the task if any values of
|
||||
the variables change. This determination is usually reliable. However, if you
|
||||
do things like construct variable names at runtime, then you might have to
|
||||
manually declare dependencies on those variables using ``vardeps`` as described
|
||||
in the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`"
|
||||
section of the BitBake User Manual.
|
||||
|
||||
If you are unsure whether a variable dependency is being picked up
|
||||
automatically for a given task, you can list the variable dependencies
|
||||
@@ -457,7 +456,7 @@ out), then you can use the ``-f`` option.
|
||||
|
||||
The reason ``-f`` is never required when running the
|
||||
:ref:`ref-tasks-devshell` task is because the
|
||||
[\ :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ]
|
||||
[\ :ref:`nostamp <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ]
|
||||
variable flag is already set for the task.
|
||||
|
||||
The following example shows one way you can use the ``-f`` option::
|
||||
@@ -572,10 +571,10 @@ log to ``${T}/log.do_``\ `task`, and can also log to standard output
|
||||
- ``bb.note(msg)``: Writes "NOTE: msg" to the log. Also logs to
|
||||
stdout if BitBake is called with "-v".
|
||||
|
||||
- ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the
|
||||
log. Also logs to stdout if the log level is greater than or equal to
|
||||
level. See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`" option
|
||||
in the BitBake User Manual for more information.
|
||||
- ``bb.debug(level, msg)``: Writes "DEBUG: msg" to the log. Also logs to
|
||||
stdout if the log level is greater than or equal to level. See the
|
||||
":ref:`bitbake-user-manual/bitbake-user-manual-intro:usage and syntax`"
|
||||
option in the BitBake User Manual for more information.
|
||||
|
||||
- ``bb.warn(msg)``: Writes "WARNING: msg" to the log while also
|
||||
logging to stdout.
|
||||
|
||||
@@ -257,15 +257,14 @@ located. For a graphical representation of source locations, see the
|
||||
":ref:`overview-manual/concepts:sources`" section in
|
||||
the Yocto Project Overview and Concepts Manual.
|
||||
|
||||
The :ref:`ref-tasks-fetch` task uses
|
||||
the prefix of each entry in the :term:`SRC_URI` variable value to determine
|
||||
which :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` to use to get your
|
||||
source files. It is the :term:`SRC_URI` variable that triggers the fetcher.
|
||||
The :ref:`ref-tasks-patch` task uses
|
||||
the variable after source is fetched to apply patches. The OpenEmbedded
|
||||
build system uses
|
||||
:term:`FILESOVERRIDES` for
|
||||
scanning directory locations for local files in :term:`SRC_URI`.
|
||||
The :ref:`ref-tasks-fetch` task uses the prefix of each entry in the
|
||||
:term:`SRC_URI` variable value to determine which
|
||||
:ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
|
||||
to use to get your source files. It is the :term:`SRC_URI` variable that triggers
|
||||
the fetcher. The :ref:`ref-tasks-patch` task uses the variable after source is
|
||||
fetched to apply patches. The OpenEmbedded build system uses
|
||||
:term:`FILESOVERRIDES` for scanning directory locations for local files in
|
||||
:term:`SRC_URI`.
|
||||
|
||||
The :term:`SRC_URI` variable in your recipe must define each unique location
|
||||
for your source files. It is good practice to not hard-code version
|
||||
@@ -1422,12 +1421,9 @@ doing the following:
|
||||
do_configure[noexec] = "1"
|
||||
do_compile[noexec] = "1"
|
||||
|
||||
Unlike
|
||||
:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`,
|
||||
using the flag preserves the dependency chain from the
|
||||
:ref:`ref-tasks-fetch`,
|
||||
:ref:`ref-tasks-unpack`, and
|
||||
:ref:`ref-tasks-patch` tasks to the
|
||||
Unlike :ref:`bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`,
|
||||
using the flag preserves the dependency chain from the :ref:`ref-tasks-fetch`,
|
||||
:ref:`ref-tasks-unpack`, and :ref:`ref-tasks-patch` tasks to the
|
||||
:ref:`ref-tasks-install` task.
|
||||
|
||||
- Make sure your :ref:`ref-tasks-install` task installs the binaries
|
||||
|
||||
@@ -999,12 +999,12 @@ test. Here is what you have to do for each recipe:
|
||||
Creating Node Package Manager (NPM) Packages
|
||||
============================================
|
||||
|
||||
:wikipedia:`NPM <Npm_(software)>` is a package
|
||||
manager for the JavaScript programming language. The Yocto Project
|
||||
supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can
|
||||
use this fetcher in combination with
|
||||
:doc:`devtool </ref-manual/devtool-reference>` to create
|
||||
recipes that produce NPM packages.
|
||||
:wikipedia:`NPM <Npm_(software)>` is a package manager for the JavaScript
|
||||
programming language. The Yocto Project supports the NPM
|
||||
:ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`.
|
||||
You can use this fetcher in combination with
|
||||
:doc:`devtool </ref-manual/devtool-reference>` to create recipes that produce
|
||||
NPM packages.
|
||||
|
||||
There are two workflows that allow you to create NPM packages using
|
||||
``devtool``: the NPM registry modules method and the NPM project code
|
||||
|
||||
@@ -27,7 +27,7 @@ functions::
|
||||
pydevshell> bb.build.exec_func("do_unpack", d)
|
||||
pydevshell>
|
||||
|
||||
See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:functions you can call from within python`"
|
||||
See the ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:functions you can call from within python`"
|
||||
section in the BitBake User Manual for details about available functions.
|
||||
|
||||
The commands execute just as if the OpenEmbedded build
|
||||
|
||||
Reference in New Issue
Block a user