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>
This commit is contained in:
Scott Rifenbark 2012-11-09 09:33:44 -06:00 committed by Richard Purdie
parent dab49aa644
commit c2f14db4e0
4 changed files with 26 additions and 4 deletions

View File

@ -347,8 +347,13 @@
the <filename>poky</filename> Git repository the <filename>poky</filename> Git repository
<filename>git://git.yoctoproject.org/poky</filename>. <filename>git://git.yoctoproject.org/poky</filename>.
Sometimes you might here the term "poky directory" used to refer to this 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 <para>The Source Directory contains BitBake, Documentation, metadata and
other files that all support the Yocto Project. other files that all support the Yocto Project.
Consequently, you must have the Source Directory in place on your development Consequently, you must have the Source Directory in place on your development

View File

@ -19,6 +19,13 @@
section in the Yocto Project Development Manual. section in the Yocto Project Development Manual.
</para> </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'> <section id='structure-core'>
<title>Top level core components</title> <title>Top level core components</title>
@ -177,6 +184,15 @@
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ source &OE_INIT_FILE; ~/mybuilds $ source &OE_INIT_FILE; ~/mybuilds
</literallayout> </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> </para>
</section> </section>

View File

@ -28,7 +28,7 @@
<para> <para>
The first thing you need to do is set up the OpenEmbedded build environment by sourcing 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'> <literallayout class='monospaced'>
$ source &OE_INIT_FILE; [build_dir] $ source &OE_INIT_FILE; [build_dir]
</literallayout> </literallayout>

View File

@ -407,7 +407,8 @@
directory.</para></listitem> directory.</para></listitem>
<listitem><para>The third and fourth commands change the working directory to the <listitem><para>The third and fourth commands change the working directory to the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> <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 Running this script defines OpenEmbedded build environment settings needed to
complete the build. complete the build.
The script also creates the The script also creates the