summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-11-09 09:33:44 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-12-03 13:52:55 +0000
commitc2f14db4e0dbcf623a8ebfa36e1a594e166ff710 (patch)
tree88020024bbb7e715fbd4e4b8673457783ae106b5
parentdab49aa6446e040bd2bfc2a5ef9e0acd51c4d06a (diff)
downloadpoky-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.xml9
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml16
-rw-r--r--documentation/poky-ref-manual/usingpoky.xml2
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml3
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 @@
347 the <filename>poky</filename> Git repository 347 the <filename>poky</filename> Git repository
348 <filename>git://git.yoctoproject.org/poky</filename>. 348 <filename>git://git.yoctoproject.org/poky</filename>.
349 Sometimes you might here the term "poky directory" used to refer to this 349 Sometimes you might here the term "poky directory" used to refer to this
350 directory structure.</para> 350 directory structure.
351 351 <note>
352 The OpenEmbedded build system does not support file or directory names that
353 contain spaces.
354 Be sure that the Source Directory you use does not contain these types
355 of names.
356 </note></para>
352 <para>The Source Directory contains BitBake, Documentation, metadata and 357 <para>The Source Directory contains BitBake, Documentation, metadata and
353 other files that all support the Yocto Project. 358 other files that all support the Yocto Project.
354 Consequently, you must have the Source Directory in place on your development 359 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 @@
19 section in the Yocto Project Development Manual. 19 section in the Yocto Project Development Manual.
20</para> 20</para>
21 21
22<note>
23 The OpenEmbedded build system does not support file or directory names that
24 contain spaces.
25 Be sure that the Source Directory you use does not contain these types
26 of names.
27</note>
28
22<section id='structure-core'> 29<section id='structure-core'>
23 <title>Top level core components</title> 30 <title>Top level core components</title>
24 31
@@ -177,6 +184,15 @@
177 <literallayout class='monospaced'> 184 <literallayout class='monospaced'>
178 $ source &OE_INIT_FILE; ~/mybuilds 185 $ source &OE_INIT_FILE; ~/mybuilds
179 </literallayout> 186 </literallayout>
187 <note>
188 The OpenEmbedded build system does not support file or directory names that
189 contain spaces.
190 If you attempt to run the <filename>&OE_INIT_FILE;</filename> script
191 from a Source Directory that contains spaces in either the filenames
192 or directory names, the script returns an error indicating no such
193 file or directory.
194 Be sure to use a Source Directory free of names containing spaces.
195 </note>
180 </para> 196 </para>
181 </section> 197 </section>
182 198
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 @@
28 28
29 <para> 29 <para>
30 The first thing you need to do is set up the OpenEmbedded build environment by sourcing 30 The first thing you need to do is set up the OpenEmbedded build environment by sourcing
31 the environment setup script as follows: 31 the <link linkend='structure-core-script'>environment setup script</link> as follows:
32 <literallayout class='monospaced'> 32 <literallayout class='monospaced'>
33 $ source &OE_INIT_FILE; [build_dir] 33 $ source &OE_INIT_FILE; [build_dir]
34 </literallayout> 34 </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 @@
407 directory.</para></listitem> 407 directory.</para></listitem>
408 <listitem><para>The third and fourth commands change the working directory to the 408 <listitem><para>The third and fourth commands change the working directory to the
409 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 409 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
410 and run the Yocto Project environment setup script. 410 and run the Yocto Project
411 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'>environment setup script</ulink>.
411 Running this script defines OpenEmbedded build environment settings needed to 412 Running this script defines OpenEmbedded build environment settings needed to
412 complete the build. 413 complete the build.
413 The script also creates the 414 The script also creates the