ref-manual: Cleaned up some instances of the term "working directory"
This term should always reference a users current working directory and not be confused with the OpenEmbedded build system's "work directory (WORKDIR). I found several instances where the term "working directory" was not used correctly and fixed them. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 300c78c1d54b2a4fbb8ecca03faa7c8c67bdc54f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
ee30c8b452
commit
936cc69a89
|
@ -693,7 +693,7 @@
|
||||||
<para>
|
<para>
|
||||||
The <filename>do_fetch</filename> and
|
The <filename>do_fetch</filename> and
|
||||||
<filename>do_unpack</filename> tasks fetch the source files
|
<filename>do_unpack</filename> tasks fetch the source files
|
||||||
and unpack them into a working directory.
|
and unpack them into the work directory.
|
||||||
By default, everything is accomplished in the
|
By default, everything is accomplished in the
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
|
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
|
||||||
which has a defined structure.
|
which has a defined structure.
|
||||||
|
|
|
@ -4825,7 +4825,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
The location in the
|
The location in the
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
|
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
|
||||||
where unpacked recipe source code resides.
|
where unpacked recipe source code resides.
|
||||||
This location is within the working directory
|
This location is within the work directory
|
||||||
(<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>),
|
(<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>),
|
||||||
which is not static.
|
which is not static.
|
||||||
The unpacked source location depends on the recipe name
|
The unpacked source location depends on the recipe name
|
||||||
|
@ -4840,7 +4840,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
|
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
|
||||||
top-level folder named <filename>poky</filename> and a
|
top-level folder named <filename>poky</filename> and a
|
||||||
default Build Directory at <filename>poky/build</filename>.
|
default Build Directory at <filename>poky/build</filename>.
|
||||||
In this case, the working directory the build system uses
|
In this case, the work directory the build system uses
|
||||||
to keep the unpacked recipe for <filename>db</filename>
|
to keep the unpacked recipe for <filename>db</filename>
|
||||||
is the following:
|
is the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
|
@ -6008,7 +6008,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
<glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
|
<glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
|
||||||
<glossdef>
|
<glossdef>
|
||||||
<para>
|
<para>
|
||||||
The pathname of the working directory in which the OpenEmbedded build system
|
The pathname of the work directory in which the OpenEmbedded build system
|
||||||
builds a recipe.
|
builds a recipe.
|
||||||
This directory is located within the
|
This directory is located within the
|
||||||
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes
|
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes
|
||||||
|
@ -6039,7 +6039,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
folder name <filename>poky</filename> and a default
|
folder name <filename>poky</filename> and a default
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
|
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
|
||||||
at <filename>poky/build</filename>.
|
at <filename>poky/build</filename>.
|
||||||
In this case, the working directory the build system uses to build
|
In this case, the work directory the build system uses to build
|
||||||
the <filename>v86d</filename> package is the following:
|
the <filename>v86d</filename> package is the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0
|
poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0
|
||||||
|
@ -6055,7 +6055,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
|
||||||
As an example, again assume a Source Directory top-level folder
|
As an example, again assume a Source Directory top-level folder
|
||||||
named <filename>poky</filename> and a default Build Directory
|
named <filename>poky</filename> and a default Build Directory
|
||||||
at <filename>poky/build</filename>.
|
at <filename>poky/build</filename>.
|
||||||
In this case, the working directory the build system uses to build
|
In this case, the work directory the build system uses to build
|
||||||
the <filename>acl</filename> recipe, which is being built for a
|
the <filename>acl</filename> recipe, which is being built for a
|
||||||
MIPS-based device, is the following:
|
MIPS-based device, is the following:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
|
|
|
@ -434,11 +434,11 @@
|
||||||
the checksum.
|
the checksum.
|
||||||
First, there is the actual specific build path of a given task -
|
First, there is the actual specific build path of a given task -
|
||||||
the <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
|
the <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
|
||||||
It does not matter if the working directory changes because it should not
|
It does not matter if the work directory changes because it should not
|
||||||
affect the output for target packages.
|
affect the output for target packages.
|
||||||
Also, the build process has the objective of making native or cross packages relocatable.
|
Also, the build process has the objective of making native or cross packages relocatable.
|
||||||
The checksum therefore needs to exclude <filename>WORKDIR</filename>.
|
The checksum therefore needs to exclude <filename>WORKDIR</filename>.
|
||||||
The simplistic approach for excluding the working directory is to set
|
The simplistic approach for excluding the work directory is to set
|
||||||
<filename>WORKDIR</filename> to some fixed value and create the checksum
|
<filename>WORKDIR</filename> to some fixed value and create the checksum
|
||||||
for the "run" script.
|
for the "run" script.
|
||||||
</para>
|
</para>
|
||||||
|
|
|
@ -169,14 +169,15 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
If you wish to rerun a task, use the <filename>-f</filename> force option.
|
If you wish to rerun a task, use the <filename>-f</filename> force
|
||||||
For example, the following sequence forces recompilation after changing files in the
|
option.
|
||||||
working directory.
|
For example, the following sequence forces recompilation after
|
||||||
|
changing files in the work directory.
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ bitbake matchbox-desktop
|
$ bitbake matchbox-desktop
|
||||||
.
|
.
|
||||||
.
|
.
|
||||||
[make some changes to the source code in the working directory]
|
[make some changes to the source code in the work directory]
|
||||||
.
|
.
|
||||||
.
|
.
|
||||||
$ bitbake matchbox-desktop -c compile -f
|
$ bitbake matchbox-desktop -c compile -f
|
||||||
|
|
Loading…
Reference in New Issue