1 files changed, 40 insertions, 53 deletions
diff --git a/bitbake/doc/user-manual/user-manual-execution.xml b/bitbake/doc/user-manual/user-manual-execution.xml
index d5a288c03f..1cb7fc63ce 100644
--- a/bitbake/doc/user-manual/user-manual-execution.xml
+++ b/bitbake/doc/user-manual/user-manual-execution.xml
@@ -151,59 +151,6 @@
            The
            "<link linkend='ref-variables-glos'>Variables Glossary</link>"
            chapter presents a full list of variables.
-<!--
-            Here are some common ones used:
-            <itemizedlist>
-                <listitem><para>
-                    <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BB_DEFAULT_TASK'><filename>BB_DEFAULT_TASK</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BBMASK'><filename>BBMASK</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <filename>BBPKGS</filename>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-ASSUME_PROVIDED'><filename>ASSUME_PROVIDED</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-PREFERRED_PROVIDERS'><filename>PREFERRED_PROVIDERS</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-MULTI_PROVIDER_WHITELIST'><filename>MULTI_PROVIDER_WHITELIST</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BBFILE_COLLECTIONS'><filename>BBFILE_COLLECTIONS</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BBDEBUG'><filename>BBDEBUG</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BB_VERBOSE_LOGS'><filename>BB_VERBOSE_LOGS</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BB_NICE_LEVEL'><filename>BB_NICE_LEVEL</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BB_DANGLINGAPPENDS_WARNONLY'><filename>BB_DANGLINGAPPENDS_WARNONLY</filename></link>
-                    </para></listitem>
-                <listitem><para>
-                    <link linkend='var-BBINCLUDED'><filename>BBINCLUDED</filename></link>
-                    </para></listitem>
-            </itemizedlist>
-->
        </para>
        <para>
@@ -235,6 +182,46 @@
            shows you the many configuration files and class files
            used in your execution environment.
        </para>
+        <note>
+            <para>
+                You need to be aware of how BitBake parses curly braces.
+                If a recipe uses a closing curly brace within the function and
+                the character has no leading spaces, BitBake produces a parsing
+                error.
+                If you use a pair of curly brace in a shell function, the
+                closing curly brace must not be located at the start of the line
+                without leading spaces.
+            </para>
+            <para>
+                Here is an example that causes BitBake to produce a parsing
+                error:
+                <literallayout class='monospaced'>
+     fakeroot create_shar() {
+         cat &lt;&lt; "EOF" &gt; ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
+     usage()
+     {
+       echo "test"
+       ###### The following "}" at the start of the line causes a parsing error ######
+     }
+     EOF
+     }
+                </literallayout>
+                Writing the recipe this way avoids the error:
+                <literallayout class='monospaced'>
+     fakeroot create_shar() {
+         cat &lt;&lt; "EOF" &gt; ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
+     usage()
+     {
+       echo "test"
+       ######The following "}" with a leading space at the start of the line avoids the error ######
+      }
+     EOF
+     }
+                </literallayout>
+            </para>
+        </note>
    </section>
    <section id='locating-and-parsing-recipes'>

diff --git a/bitbake/doc/user-manual/user-manual-execution.xml b/bitbake/doc/user-manual/user-manual-execution.xml index d5a288c03f..1cb7fc63ce 100644 --- a/bitbake/doc/user-manual/user-manual-execution.xml +++ b/bitbake/doc/user-manual/user-manual-execution.xml
@@ -151,59 +151,6 @@
151	The	151	The
152	"<link linkend='ref-variables-glos'>Variables Glossary</link>"	152	"<link linkend='ref-variables-glos'>Variables Glossary</link>"
153	chapter presents a full list of variables.	153	chapter presents a full list of variables.
154	<!--
155	Here are some common ones used:
156	<itemizedlist>
157	<listitem><para>
158	<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
159	</para></listitem>
160	<listitem><para>
161	<link linkend='var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></link>
162	</para></listitem>
163	<listitem><para>
164	<link linkend='var-BB_DEFAULT_TASK'><filename>BB_DEFAULT_TASK</filename></link>
165	</para></listitem>
166	<listitem><para>
167	<link linkend='var-BBMASK'><filename>BBMASK</filename></link>
168	</para></listitem>
169	<listitem><para>
170	<filename>BBPKGS</filename>
171	</para></listitem>
172	<listitem><para>
173	<link linkend='var-TOPDIR'><filename>TOPDIR</filename></link>
174	</para></listitem>
175	<listitem><para>
176	<link linkend='var-ASSUME_PROVIDED'><filename>ASSUME_PROVIDED</filename></link>
177	</para></listitem>
178	<listitem><para>
179	<link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link>
180	</para></listitem>
181	<listitem><para>
182	<link linkend='var-PREFERRED_PROVIDERS'><filename>PREFERRED_PROVIDERS</filename></link>
183	</para></listitem>
184	<listitem><para>
185	<link linkend='var-MULTI_PROVIDER_WHITELIST'><filename>MULTI_PROVIDER_WHITELIST</filename></link>
186	</para></listitem>
187	<listitem><para>
188	<link linkend='var-BBFILE_COLLECTIONS'><filename>BBFILE_COLLECTIONS</filename></link>
189	</para></listitem>
190	<listitem><para>
191	<link linkend='var-BBDEBUG'><filename>BBDEBUG</filename></link>
192	</para></listitem>
193	<listitem><para>
194	<link linkend='var-BB_VERBOSE_LOGS'><filename>BB_VERBOSE_LOGS</filename></link>
195	</para></listitem>
196	<listitem><para>
197	<link linkend='var-BB_NICE_LEVEL'><filename>BB_NICE_LEVEL</filename></link>
198	</para></listitem>
199	<listitem><para>
200	<link linkend='var-BB_DANGLINGAPPENDS_WARNONLY'><filename>BB_DANGLINGAPPENDS_WARNONLY</filename></link>
201	</para></listitem>
202	<listitem><para>
203	<link linkend='var-BBINCLUDED'><filename>BBINCLUDED</filename></link>
204	</para></listitem>
205	</itemizedlist>
206	-->
207	</para>	154	</para>
208		155
209	<para>	156	<para>
@@ -235,6 +182,46 @@
235	shows you the many configuration files and class files	182	shows you the many configuration files and class files
236	used in your execution environment.	183	used in your execution environment.
237	</para>	184	</para>
		185
		186	<note>
		187	<para>
		188	You need to be aware of how BitBake parses curly braces.
		189	If a recipe uses a closing curly brace within the function and
		190	the character has no leading spaces, BitBake produces a parsing
		191	error.
		192	If you use a pair of curly brace in a shell function, the
		193	closing curly brace must not be located at the start of the line
		194	without leading spaces.
		195	</para>
		196
		197	<para>
		198	Here is an example that causes BitBake to produce a parsing
		199	error:
		200	<literallayout class='monospaced'>
		201	fakeroot create_shar() {
		202	cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
		203	usage()
		204	{
		205	echo "test"
		206	###### The following "}" at the start of the line causes a parsing error ######
		207	}
		208	EOF
		209	}
		210	</literallayout>
		211	Writing the recipe this way avoids the error:
		212	<literallayout class='monospaced'>
		213	fakeroot create_shar() {
		214	cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
		215	usage()
		216	{
		217	echo "test"
		218	######The following "}" with a leading space at the start of the line avoids the error ######
		219	}
		220	EOF
		221	}
		222	</literallayout>
		223	</para>
		224	</note>
238	</section>	225	</section>
239		226
240	<section id='locating-and-parsing-recipes'>	227	<section id='locating-and-parsing-recipes'>