diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-11-21 09:40:12 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:15 +0000 |
commit | 936cc69a8997ebaf7ed68ea1283f8f733b5e4745 (patch) | |
tree | 0daa2fca3c0604c2371af9d1944f76be590595f4 /documentation | |
parent | ee30c8b452e290f609820f3d09b2a4afbe09f179 (diff) | |
download | poky-936cc69a8997ebaf7ed68ea1283f8f733b5e4745.tar.gz |
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/closer-look.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 10 | ||||
-rw-r--r-- | documentation/ref-manual/technical-details.xml | 4 | ||||
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 9 |
4 files changed, 13 insertions, 12 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index 4883981985..e13f5c1601 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml | |||
@@ -693,7 +693,7 @@ | |||
693 | <para> | 693 | <para> |
694 | The <filename>do_fetch</filename> and | 694 | The <filename>do_fetch</filename> and |
695 | <filename>do_unpack</filename> tasks fetch the source files | 695 | <filename>do_unpack</filename> tasks fetch the source files |
696 | and unpack them into a working directory. | 696 | and unpack them into the work directory. |
697 | By default, everything is accomplished in the | 697 | By default, everything is accomplished in the |
698 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 698 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, |
699 | which has a defined structure. | 699 | which has a defined structure. |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index cb8d9a5b39..bed4be0030 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -4825,7 +4825,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
4825 | The location in the | 4825 | The location in the |
4826 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 4826 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
4827 | where unpacked recipe source code resides. | 4827 | where unpacked recipe source code resides. |
4828 | This location is within the working directory | 4828 | This location is within the work directory |
4829 | (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), | 4829 | (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), |
4830 | which is not static. | 4830 | which is not static. |
4831 | The unpacked source location depends on the recipe name | 4831 | 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" | |||
4840 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 4840 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
4841 | top-level folder named <filename>poky</filename> and a | 4841 | top-level folder named <filename>poky</filename> and a |
4842 | default Build Directory at <filename>poky/build</filename>. | 4842 | default Build Directory at <filename>poky/build</filename>. |
4843 | In this case, the working directory the build system uses | 4843 | In this case, the work directory the build system uses |
4844 | to keep the unpacked recipe for <filename>db</filename> | 4844 | to keep the unpacked recipe for <filename>db</filename> |
4845 | is the following: | 4845 | is the following: |
4846 | <literallayout class='monospaced'> | 4846 | <literallayout class='monospaced'> |
@@ -6008,7 +6008,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6008 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> | 6008 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> |
6009 | <glossdef> | 6009 | <glossdef> |
6010 | <para> | 6010 | <para> |
6011 | The pathname of the working directory in which the OpenEmbedded build system | 6011 | The pathname of the work directory in which the OpenEmbedded build system |
6012 | builds a recipe. | 6012 | builds a recipe. |
6013 | This directory is located within the | 6013 | This directory is located within the |
6014 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes | 6014 | <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" | |||
6039 | folder name <filename>poky</filename> and a default | 6039 | folder name <filename>poky</filename> and a default |
6040 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 6040 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
6041 | at <filename>poky/build</filename>. | 6041 | at <filename>poky/build</filename>. |
6042 | In this case, the working directory the build system uses to build | 6042 | In this case, the work directory the build system uses to build |
6043 | the <filename>v86d</filename> package is the following: | 6043 | the <filename>v86d</filename> package is the following: |
6044 | <literallayout class='monospaced'> | 6044 | <literallayout class='monospaced'> |
6045 | poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0 | 6045 | 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" | |||
6055 | As an example, again assume a Source Directory top-level folder | 6055 | As an example, again assume a Source Directory top-level folder |
6056 | named <filename>poky</filename> and a default Build Directory | 6056 | named <filename>poky</filename> and a default Build Directory |
6057 | at <filename>poky/build</filename>. | 6057 | at <filename>poky/build</filename>. |
6058 | In this case, the working directory the build system uses to build | 6058 | In this case, the work directory the build system uses to build |
6059 | the <filename>acl</filename> recipe, which is being built for a | 6059 | the <filename>acl</filename> recipe, which is being built for a |
6060 | MIPS-based device, is the following: | 6060 | MIPS-based device, is the following: |
6061 | <literallayout class='monospaced'> | 6061 | <literallayout class='monospaced'> |
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 6d4c6b712c..51b9148e3e 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
@@ -434,11 +434,11 @@ | |||
434 | the checksum. | 434 | the checksum. |
435 | First, there is the actual specific build path of a given task - | 435 | First, there is the actual specific build path of a given task - |
436 | the <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. | 436 | the <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. |
437 | It does not matter if the working directory changes because it should not | 437 | It does not matter if the work directory changes because it should not |
438 | affect the output for target packages. | 438 | affect the output for target packages. |
439 | Also, the build process has the objective of making native or cross packages relocatable. | 439 | Also, the build process has the objective of making native or cross packages relocatable. |
440 | The checksum therefore needs to exclude <filename>WORKDIR</filename>. | 440 | The checksum therefore needs to exclude <filename>WORKDIR</filename>. |
441 | The simplistic approach for excluding the working directory is to set | 441 | The simplistic approach for excluding the work directory is to set |
442 | <filename>WORKDIR</filename> to some fixed value and create the checksum | 442 | <filename>WORKDIR</filename> to some fixed value and create the checksum |
443 | for the "run" script. | 443 | for the "run" script. |
444 | </para> | 444 | </para> |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index b9df733f3f..94f113590a 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -169,14 +169,15 @@ | |||
169 | </para> | 169 | </para> |
170 | 170 | ||
171 | <para> | 171 | <para> |
172 | If you wish to rerun a task, use the <filename>-f</filename> force option. | 172 | If you wish to rerun a task, use the <filename>-f</filename> force |
173 | For example, the following sequence forces recompilation after changing files in the | 173 | option. |
174 | working directory. | 174 | For example, the following sequence forces recompilation after |
175 | changing files in the work directory. | ||
175 | <literallayout class='monospaced'> | 176 | <literallayout class='monospaced'> |
176 | $ bitbake matchbox-desktop | 177 | $ bitbake matchbox-desktop |
177 | . | 178 | . |
178 | . | 179 | . |
179 | [make some changes to the source code in the working directory] | 180 | [make some changes to the source code in the work directory] |
180 | . | 181 | . |
181 | . | 182 | . |
182 | $ bitbake matchbox-desktop -c compile -f | 183 | $ bitbake matchbox-desktop -c compile -f |