sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Updates to the "Understanding Recipe Syntax" section. 

Paul Eggleton sent me some feedback on this section.  I implemented
his suggestions.  Changes were minor.  One included a cross-link
to the BitBake User Manual.

(From yocto-docs rev: e9b5f252a1368b8c231dd659428a18eacf9757af)

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 2014-06-02 15:57:50 +03:00 committed by Richard Purdie
parent 84ee8c653a
commit a456afa06c
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -1400,8 +1400,13 @@
<title>Understanding Recipe Syntax</title>
<para>
The basic items that make up a BitBake recipe file are
as follows:
Understanding recipe file syntax is important for
writing recipes.
The following list overviews the basic items that make up a
BitBake recipe file.
For more complete BitBake syntax descriptions, see the
"<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata'>Syntax and Operators</ulink>"
chapter of the BitBake User Manual.
<itemizedlist>
<listitem><para><emphasis>Variable Assignments and Manipulations:</emphasis>
Variable assignments allow a value to be assigned to a
@ -1519,18 +1524,16 @@
<filename>local.conf</filename> file for variables
that are allowed to come through from the external
environment.
Doing so allows you to actually set variables from
the external environment that would otherwise be
overwritten.</para>
<para>Here is an example:
</para>
<para>Here is an example where
<filename>VAR1</filename> is set to "New value" if
it is currently empty.
However, if <filename>VAR1</filename> has already been
set, it remains unchanged:
<literallayout class='monospaced'>
VAR1 ?= "New value"
</literallayout>
In the previous example, <filename>VAR1</filename> is
set to "New value" if it is currently empty.
However, if <filename>VAR1</filename> has already been
set, it remains unchanged.</para>
<para>In this next example, <filename>VAR1</filename>
In this next example, <filename>VAR1</filename>
is left with the value "Original value":
<literallayout class='monospaced'>
VAR1 = "Original value"
@ -1632,7 +1635,7 @@
</literallayout>
</para></listitem>
<listitem><para><emphasis>Shell Function Syntax:</emphasis>
Use shell function syntax as if you were writing a shell
Write shell functions as if you were writing a shell
script when you describe a list of actions to take.
You should ensure that your script works with a generic
<filename>sh</filename> and that it does not require