diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-11-09 09:33:44 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-03 13:52:55 +0000 |
commit | c2f14db4e0dbcf623a8ebfa36e1a594e166ff710 (patch) | |
tree | 88020024bbb7e715fbd4e4b8673457783ae106b5 | |
parent | dab49aa6446e040bd2bfc2a5ef9e0acd51c4d06a (diff) | |
download | openembedded-core-contrib-c2f14db4e0dbcf623a8ebfa36e1a594e166ff710.tar.gz |
documentation: several manuals - Notes and links for filename space issue
Fixes [YOCTO_#3396]
Spaces in file and directory names is an issue for the build
system and throws an error when sourcing the environment
setup script. I added key notes in several areas of the doc
set. I also added some cross-references to the oe-init-build-env
section in some other areas where running the script is discussed.
(From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 9 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-structure.xml | 16 | ||||
-rw-r--r-- | documentation/poky-ref-manual/usingpoky.xml | 2 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 3 |
4 files changed, 26 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index bb01131c05..37f705b0ee 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -347,8 +347,13 @@ the <filename>poky</filename> Git repository <filename>git://git.yoctoproject.org/poky</filename>. Sometimes you might here the term "poky directory" used to refer to this - directory structure.</para> - + directory structure. + <note> + The OpenEmbedded build system does not support file or directory names that + contain spaces. + Be sure that the Source Directory you use does not contain these types + of names. + </note></para> <para>The Source Directory contains BitBake, Documentation, metadata and other files that all support the Yocto Project. Consequently, you must have the Source Directory in place on your development diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index be2773b624..c2644df374 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -19,6 +19,13 @@ section in the Yocto Project Development Manual. </para> +<note> + The OpenEmbedded build system does not support file or directory names that + contain spaces. + Be sure that the Source Directory you use does not contain these types + of names. +</note> + <section id='structure-core'> <title>Top level core components</title> @@ -177,6 +184,15 @@ <literallayout class='monospaced'> $ source &OE_INIT_FILE; ~/mybuilds </literallayout> + <note> + The OpenEmbedded build system does not support file or directory names that + contain spaces. + If you attempt to run the <filename>&OE_INIT_FILE;</filename> script + from a Source Directory that contains spaces in either the filenames + or directory names, the script returns an error indicating no such + file or directory. + Be sure to use a Source Directory free of names containing spaces. + </note> </para> </section> diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index bc82c70d90..567e721e4e 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml @@ -28,7 +28,7 @@ <para> The first thing you need to do is set up the OpenEmbedded build environment by sourcing - the environment setup script as follows: + the <link linkend='structure-core-script'>environment setup script</link> as follows: <literallayout class='monospaced'> $ source &OE_INIT_FILE; [build_dir] </literallayout> diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 3594b6ea50..78eb144162 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -407,7 +407,8 @@ directory.</para></listitem> <listitem><para>The third and fourth commands change the working directory to the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> - and run the Yocto Project environment setup script. + and run the Yocto Project + <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'>environment setup script</ulink>. Running this script defines OpenEmbedded build environment settings needed to complete the build. The script also creates the |