bitbake: bitbake-user-manual: Formatted all "flags" to be consistent
Fixes [YOCTO #10071] The use of any flags throughout the manual was very inconsistent. I changed all references to any named flag in the text to be formatted as code and to be enclosed in square brackets. (Bitbake rev: be0fb616e64e54ae3e2420249f21f4edfd97d648) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
50d78130fd
commit
3a1ae38966
|
@ -596,7 +596,7 @@
|
||||||
"<link linkend='checksums'>Checksums (Signatures)</link>"
|
"<link linkend='checksums'>Checksums (Signatures)</link>"
|
||||||
section for information).
|
section for information).
|
||||||
It is also possible to append extra metadata to the stamp using
|
It is also possible to append extra metadata to the stamp using
|
||||||
the "stamp-extra-info" task flag.
|
the <filename>[stamp-extra-info]</filename> task flag.
|
||||||
For example, OpenEmbedded uses this flag to make some tasks machine-specific.
|
For example, OpenEmbedded uses this flag to make some tasks machine-specific.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@ -653,7 +653,8 @@
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
It is possible to have functions run before and after a task's main
|
It is possible to have functions run before and after a task's main
|
||||||
function.
|
function.
|
||||||
This is done using the "prefuncs" and "postfuncs" flags of the task
|
This is done using the <filename>[prefuncs]</filename>
|
||||||
|
and <filename>[postfuncs]</filename> flags of the task
|
||||||
that lists the functions to run.
|
that lists the functions to run.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -372,9 +372,9 @@
|
||||||
FOO[a] += "456"
|
FOO[a] += "456"
|
||||||
</literallayout>
|
</literallayout>
|
||||||
The variable <filename>FOO</filename> has two flags:
|
The variable <filename>FOO</filename> has two flags:
|
||||||
<filename>a</filename> and <filename>b</filename>.
|
<filename>[a]</filename> and <filename>[b]</filename>.
|
||||||
The flags are immediately set to "abc" and "123", respectively.
|
The flags are immediately set to "abc" and "123", respectively.
|
||||||
The <filename>a</filename> flag becomes "abc 456".
|
The <filename>[a]</filename> flag becomes "abc 456".
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -1270,7 +1270,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
If you want dependencies such as these to remain intact, use
|
If you want dependencies such as these to remain intact, use
|
||||||
the <filename>noexec</filename> varflag to disable the task
|
the <filename>[noexec]</filename> varflag to disable the task
|
||||||
instead of using the <filename>deltask</filename> command to
|
instead of using the <filename>deltask</filename> command to
|
||||||
delete it:
|
delete it:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
|
@ -1393,13 +1393,13 @@
|
||||||
Tasks support a number of these flags which control various
|
Tasks support a number of these flags which control various
|
||||||
functionality of the task:
|
functionality of the task:
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para><emphasis>cleandirs:</emphasis>
|
<listitem><para><emphasis><filename>[cleandirs]</filename>:</emphasis>
|
||||||
Empty directories that should be created before the
|
Empty directories that should be created before the
|
||||||
task runs.
|
task runs.
|
||||||
Directories that already exist are removed and recreated
|
Directories that already exist are removed and recreated
|
||||||
to empty them.
|
to empty them.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>depends:</emphasis>
|
<listitem><para><emphasis><filename>[depends]</filename>:</emphasis>
|
||||||
Controls inter-task dependencies.
|
Controls inter-task dependencies.
|
||||||
See the
|
See the
|
||||||
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
||||||
|
@ -1407,7 +1407,7 @@
|
||||||
"<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>"
|
"<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>"
|
||||||
section for more information.
|
section for more information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>deptask:</emphasis>
|
<listitem><para><emphasis><filename>[deptask]</filename>:</emphasis>
|
||||||
Controls task build-time dependencies.
|
Controls task build-time dependencies.
|
||||||
See the
|
See the
|
||||||
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
||||||
|
@ -1415,13 +1415,13 @@
|
||||||
"<link linkend='build-dependencies'>Build Dependencies</link>"
|
"<link linkend='build-dependencies'>Build Dependencies</link>"
|
||||||
section for more information.
|
section for more information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>dirs:</emphasis>
|
<listitem><para><emphasis><filename>[dirs]</filename>:</emphasis>
|
||||||
Directories that should be created before the task runs.
|
Directories that should be created before the task runs.
|
||||||
Directories that already exist are left as is.
|
Directories that already exist are left as is.
|
||||||
The last directory listed is used as the
|
The last directory listed is used as the
|
||||||
current working directory for the task.
|
current working directory for the task.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>lockfiles:</emphasis>
|
<listitem><para><emphasis><filename>[lockfiles]</filename>:</emphasis>
|
||||||
Specifies one or more lockfiles to lock while the task
|
Specifies one or more lockfiles to lock while the task
|
||||||
executes.
|
executes.
|
||||||
Only one task may hold a lockfile, and any task that
|
Only one task may hold a lockfile, and any task that
|
||||||
|
@ -1430,23 +1430,23 @@
|
||||||
You can use this variable flag to accomplish mutual
|
You can use this variable flag to accomplish mutual
|
||||||
exclusion.
|
exclusion.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>noexec:</emphasis>
|
<listitem><para><emphasis><filename>[noexec]</filename>:</emphasis>
|
||||||
Marks the tasks as being empty and no execution required.
|
Marks the tasks as being empty and no execution required.
|
||||||
The <filename>noexec</filename> flag can be used to set up
|
The <filename>[noexec]</filename> flag can be used to set up
|
||||||
tasks as dependency placeholders, or to disable tasks defined
|
tasks as dependency placeholders, or to disable tasks defined
|
||||||
elsewhere that are not needed in a particular recipe.
|
elsewhere that are not needed in a particular recipe.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>nostamp:</emphasis>
|
<listitem><para><emphasis><filename>[nostamp]</filename>:</emphasis>
|
||||||
Tells BitBake to not generate a stamp file for a task,
|
Tells BitBake to not generate a stamp file for a task,
|
||||||
which implies the task should always be executed.
|
which implies the task should always be executed.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>postfuncs:</emphasis>
|
<listitem><para><emphasis><filename>[postfuncs]</filename>:</emphasis>
|
||||||
List of functions to call after the completion of the task.
|
List of functions to call after the completion of the task.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>prefuncs:</emphasis>
|
<listitem><para><emphasis><filename>[prefuncs]</filename>:</emphasis>
|
||||||
List of functions to call before the task executes.
|
List of functions to call before the task executes.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>rdepends:</emphasis>
|
<listitem><para><emphasis><filename>[rdepends]</filename>:</emphasis>
|
||||||
Controls inter-task runtime dependencies.
|
Controls inter-task runtime dependencies.
|
||||||
See the
|
See the
|
||||||
<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
|
<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
|
||||||
|
@ -1456,7 +1456,7 @@
|
||||||
"<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>"
|
"<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>"
|
||||||
section for more information.
|
section for more information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>rdeptask:</emphasis>
|
<listitem><para><emphasis><filename>[rdeptask]</filename>:</emphasis>
|
||||||
Controls task runtime dependencies.
|
Controls task runtime dependencies.
|
||||||
See the
|
See the
|
||||||
<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
|
<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
|
||||||
|
@ -1466,12 +1466,12 @@
|
||||||
"<link linkend='runtime-dependencies'>Runtime Dependencies</link>"
|
"<link linkend='runtime-dependencies'>Runtime Dependencies</link>"
|
||||||
section for more information.
|
section for more information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>recideptask:</emphasis>
|
<listitem><para><emphasis><filename>[recideptask]</filename>:</emphasis>
|
||||||
When set in conjunction with
|
When set in conjunction with
|
||||||
<filename>recrdeptask</filename>, specifies a task that
|
<filename>recrdeptask</filename>, specifies a task that
|
||||||
should be inspected for additional dependencies.
|
should be inspected for additional dependencies.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>recrdeptask:</emphasis>
|
<listitem><para><emphasis><filename>[recrdeptask]</filename>:</emphasis>
|
||||||
Controls task recursive runtime dependencies.
|
Controls task recursive runtime dependencies.
|
||||||
See the
|
See the
|
||||||
<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
|
<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
|
||||||
|
@ -1481,12 +1481,12 @@
|
||||||
"<link linkend='recursive-dependencies'>Recursive Dependencies</link>"
|
"<link linkend='recursive-dependencies'>Recursive Dependencies</link>"
|
||||||
section for more information.
|
section for more information.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>stamp-extra-info:</emphasis>
|
<listitem><para><emphasis><filename>[stamp-extra-info]</filename>:</emphasis>
|
||||||
Extra stamp information to append to the task's stamp.
|
Extra stamp information to append to the task's stamp.
|
||||||
As an example, OpenEmbedded uses this flag to allow
|
As an example, OpenEmbedded uses this flag to allow
|
||||||
machine-specific tasks.
|
machine-specific tasks.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>umask:</emphasis>
|
<listitem><para><emphasis><filename>[umask]</filename>:</emphasis>
|
||||||
The umask to run the task under.
|
The umask to run the task under.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
@ -1499,7 +1499,7 @@
|
||||||
"<link linkend='checksums'>Checksums (Signatures)</link>"
|
"<link linkend='checksums'>Checksums (Signatures)</link>"
|
||||||
section.
|
section.
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para><emphasis>vardeps:</emphasis>
|
<listitem><para><emphasis><filename>[vardeps]</filename>:</emphasis>
|
||||||
Specifies a space-separated list of additional
|
Specifies a space-separated list of additional
|
||||||
variables to add to a variable's dependencies
|
variables to add to a variable's dependencies
|
||||||
for the purposes of calculating its signature.
|
for the purposes of calculating its signature.
|
||||||
|
@ -1508,17 +1508,17 @@
|
||||||
does not allow BitBake to automatically determine
|
does not allow BitBake to automatically determine
|
||||||
that the variable is referred to.
|
that the variable is referred to.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>vardepsexclude:</emphasis>
|
<listitem><para><emphasis><filename>[vardepsexclude]</filename>:</emphasis>
|
||||||
Specifies a space-separated list of variables
|
Specifies a space-separated list of variables
|
||||||
that should be excluded from a variable's dependencies
|
that should be excluded from a variable's dependencies
|
||||||
for the purposes of calculating its signature.
|
for the purposes of calculating its signature.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>vardepvalue:</emphasis>
|
<listitem><para><emphasis><filename>[vardepvalue]</filename>:</emphasis>
|
||||||
If set, instructs BitBake to ignore the actual
|
If set, instructs BitBake to ignore the actual
|
||||||
value of the variable and instead use the specified
|
value of the variable and instead use the specified
|
||||||
value when calculating the variable's signature.
|
value when calculating the variable's signature.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para><emphasis>vardepvalueexclude:</emphasis>
|
<listitem><para><emphasis><filename>[vardepvalueexclude]</filename>:</emphasis>
|
||||||
Specifies a pipe-separated list of strings to exclude
|
Specifies a pipe-separated list of strings to exclude
|
||||||
from the variable's value when calculating the
|
from the variable's value when calculating the
|
||||||
variable's signature.
|
variable's signature.
|
||||||
|
@ -1816,7 +1816,8 @@
|
||||||
BitBake uses the
|
BitBake uses the
|
||||||
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
|
||||||
variable to manage build time dependencies.
|
variable to manage build time dependencies.
|
||||||
The "deptask" varflag for tasks signifies the task of each
|
The <filename>[deptask]</filename> varflag for tasks
|
||||||
|
signifies the task of each
|
||||||
item listed in <filename>DEPENDS</filename> that must
|
item listed in <filename>DEPENDS</filename> that must
|
||||||
complete before that task can be executed.
|
complete before that task can be executed.
|
||||||
Here is an example:
|
Here is an example:
|
||||||
|
@ -1845,7 +1846,8 @@
|
||||||
packages.
|
packages.
|
||||||
Each of those packages can have <filename>RDEPENDS</filename> and
|
Each of those packages can have <filename>RDEPENDS</filename> and
|
||||||
<filename>RRECOMMENDS</filename> runtime dependencies.
|
<filename>RRECOMMENDS</filename> runtime dependencies.
|
||||||
The "rdeptask" flag for tasks is used to signify the task of each
|
The <filename>[rdeptask]</filename> flag for tasks is used to
|
||||||
|
signify the task of each
|
||||||
item runtime dependency which must have completed before that
|
item runtime dependency which must have completed before that
|
||||||
task can be executed.
|
task can be executed.
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
|
@ -1861,7 +1863,7 @@
|
||||||
<title>Recursive Dependencies</title>
|
<title>Recursive Dependencies</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
BitBake uses the "recrdeptask" flag to manage
|
BitBake uses the <filename>[recrdeptask]</filename> flag to manage
|
||||||
recursive task dependencies.
|
recursive task dependencies.
|
||||||
BitBake looks through the build-time and runtime
|
BitBake looks through the build-time and runtime
|
||||||
dependencies of the current recipe, looks through
|
dependencies of the current recipe, looks through
|
||||||
|
@ -1875,7 +1877,8 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The "recrdeptask" flag is most commonly used in high-level
|
The <filename>[recrdeptask]</filename> flag is most commonly
|
||||||
|
used in high-level
|
||||||
recipes that need to wait for some task to finish "globally".
|
recipes that need to wait for some task to finish "globally".
|
||||||
For example, <filename>image.bbclass</filename> has the following:
|
For example, <filename>image.bbclass</filename> has the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
|
@ -1905,7 +1908,8 @@
|
||||||
<title>Inter-Task Dependencies</title>
|
<title>Inter-Task Dependencies</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
BitBake uses the "depends" flag in a more generic form
|
BitBake uses the <filename>[depends]</filename>
|
||||||
|
flag in a more generic form
|
||||||
to manage inter-task dependencies.
|
to manage inter-task dependencies.
|
||||||
This more generic form allows for inter-dependency
|
This more generic form allows for inter-dependency
|
||||||
checks for specific tasks rather than checks for
|
checks for specific tasks rather than checks for
|
||||||
|
@ -1921,7 +1925,8 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The "rdepends" flag works in a similar way but takes targets
|
The <filename>[rdepends]</filename> flag works in a similar
|
||||||
|
way but takes targets
|
||||||
in the runtime namespace instead of the build-time dependency
|
in the runtime namespace instead of the build-time dependency
|
||||||
namespace.
|
namespace.
|
||||||
</para>
|
</para>
|
||||||
|
|
Loading…
Reference in New Issue