Commit Graph

45 Commits

Author SHA1 Message Date
Scott Rifenbark cbf8516c08 bitbake: bitbake-user-manual: Added setting variable for a single task
Fixes [YOCTO #10095]

I added a third case to the "Conditional Metadata" section to
describe setting a variable for a single task.

(Bitbake rev: 24d648ce62b35f7d2b23fde732703c060579a0d2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17 10:22:59 +01:00
Scott Rifenbark 277a5a969f bitbake: bitbake-user-manual: Added more detail to anonymous Python functions.
Fixes [YOCTO #10093]

Provided much more detail on how these functions work.

(Bitbake rev: dbe25523d899850f85acb6986eca98bf1b0ef52a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17 10:22:59 +01:00
Scott Rifenbark 3a1ae38966 bitbake: bitbake-user-manual: Formatted all "flags" to be consistent
Fixes [YOCTO #10071]

The use of any flags throughout the manual was very inconsistent.
I changed all references to any named flag in the text to be
formatted as code and to be enclosed in square brackets.

(Bitbake rev: be0fb616e64e54ae3e2420249f21f4edfd97d648)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17 10:22:59 +01:00
Scott Rifenbark 50d78130fd bitbake: bitbake-user-manual: Added detail to [dirs] and [cleardirs] flags
Fixes [YOCTO #10071]

Provided more clear descriptions for these two flags.

(Bitbake rev: c85c9a468dc3ce606a5f8797e6be8b411a9f3bdb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17 10:22:59 +01:00
Scott Rifenbark a3cad8f0e0 bitbake: bitbake-user-manual: Applied typo fix to "Override Style Operation Advantages"
Fixes [YOCTO #9985]

Fixed an operator typo from ":=" to "+=" in the note
at the bottom of the section.

(Bitbake rev: 319d3d387161182069e6d1b3db17ccb539d097ed)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Scott Rifenbark f0e73a4b65 bitbake: bitbake-user-manual: Added non-existant variable expansion
Fixes [YOCTO #10003]

I added a small paragraph explaining what happens when expansion
of a variable that does not exist occurs.

(Bitbake rev: 8006da3f229d0227215ccd59cd273edacf72f9ce)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Scott Rifenbark 41b49cadd3 bitbake: bitbake-user-manual: Applied some review comments
Fixes [YOCTO #9985]

Fixed some problems with the changes.  A small typo for an
example and added a clarifying operator in another sentence.

(Bitbake rev: d8ae3775eefe3f7b62fc26cae5b742ae83850c13)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Scott Rifenbark a3a7ddf120 bitbake: bitbake-user-manual: Updated the "Inline Python Variable Expansion" section.
Fixes [YOCTO #9984]

Added a small note to the bottom to help clarify.

(Bitbake rev: 64bf49826088c56b739ed971251f05b4564c712e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Scott Rifenbark eb282b797e bitbake: bitbake-user-manual: Fixed override operator syntax.
I had inconsistent usage of the "_append" style operator syntax
in the chaper.  I was using a mix of <filename>_append</filename>
and "_append".  I changed to "_append" for consistency.

(Bitbake rev: 5c5b88e402376268baa15c5d04d2592f28d76751)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Scott Rifenbark 6aaf379119 bitbake: bitbake-user-manual: Clarified override-style operators.
Fixes [YOCTO #9985]

Made the following changes:

 * Section Removal (Override Style Syntax):  Added a small
   qualifying sentence at the end to further define behavior

 * Added new section "Override Style Operation Advantages":
   This section provides some rationale behind the "_append"
   style operations.

 * Section "Examples": Changed an example to use the "="
   operator rather than the "+=" operator.

(Bitbake rev: 797d9627baad9ccd3d55e825c0d705311f631f78)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Scott Rifenbark d1e3f0bb16 bitbake: bitbake-user-manual: Updated the variable expansion section.
Fixes [YOCTO #9984]

Added more detail to the examples that show the effects of
variable expanison.

(Bitbake rev: 480096ca93c0a649ebfff68dfc7d9bbe8eb2ea2d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:14 +01:00
Scott Rifenbark cb40ae4872 bitbake: bitbake-user-manual: Applied review edits to "Recursive Dependencies"
Added a minor tweak to the third paragraph to be more inclusive
of the topic.

Fixes [YOCTO #9970]

(Bitbake rev: a5d36e8bccf35ffbca41a4facaa041d36f587529)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:54 +01:00
Scott Rifenbark 4bc1ee5de4 bitbake: bitbake-user-manual: Added review changes to recursive section.
Applied formatting to a "after" word that should be
<filename>after</filename>.  Also added a new clarifying paragraph in
the "Recursive Dependencies" section.

Fixes [YOCTO #9861]

(Bitbake rev: ada90f68afd17cb85cb5957f3f91b537ee3599f6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:53 +01:00
Scott Rifenbark 8c55a9cf88 bitbake: bitbake-user-manual: Added a note providing examples of task dependencies
Fixes [YOCTO #9861]

In the "Dependencies internal to the .bb File" section, I placed a
note providing more detail on how recipes are built regarding task
dependency.

(Bitbake rev: c2e72928fbd21d622860a54a55f4239ba27c07a2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:53 +01:00
Scott Rifenbark d918df7e8e bitbake: bitbake-user-manual: Updated dependency section for tasks
Fixes [YOCTO #9861]

I updated the section on dependencies to give a couple of examples
for task dependencies within a single recipe and dependencies for
tasks between two individual recipes.

(Bitbake rev: 231deeb2b0b3847cba971ca30c16e29357100ae6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:53 +01:00
Scott Rifenbark 6743f12bbf bitbake: bitbake-user-manual: Updated the defaults for getVar and getVarFlag
There is no default.

Fixes [YOCTO #9683]

(Bitbake rev: 886afd6d876c9ae04cf681931db8f1774dc53096)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:53 +01:00
Scott Rifenbark 890ccd34b1 bitbake: bitbake-user-manual: Updated "Conditional Metadata" section
Added information about using lower-case characters and no
underscore characters when using OVERRIDES.

(Bitbake rev: 4397a023f8bf738913d71a38b3e06503207311e2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:20:50 +01:00
Scott Rifenbark 20a0121b55 bitbake: bitbake-user-manual: Updated discussion about using "inherit"
Fixes [YOCTO #9343]

I updated the inherit directive section to note that you can
inherit multiple classes using a single line.

(Bitbake rev: 3f29ebec593f20894f7a2a0b6d50ee22474aee75)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-15 06:59:44 +01:00
Scott Rifenbark 5c7e5aa71c bitbake: bitbake-user-manual: include/require checks current directory
I added wording to note that include/require checks the current
directory in addition to BBPATH

Fixes [YOCTO #8566]

(Bitbake rev: bdad45ebe551912b055ffa349d254ae5947a3ba6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:55:38 +00:00
Scott Rifenbark 7ec8f286f7 bitbake: bitbake-user-manual: Updated the "inherit Directive" section.
Fixes [YOCTO #9283]

Updated the description to document conditional inherits.  Provided
several examples.

(Bitbake rev: 07f97f4d913cf1c8233995152105fff6c6c7b9a0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:55:38 +00:00
Scott Rifenbark 353b755177 bitbake: bitbake-user-manual: Added expand() function to list.
Fixes [YOCTO #9147]

Added the d.expand(expression) fuction to the list of functions
in the "Accessing Datastore Variables Using Python" section.

(Bitbake rev: 19507b80f35d37dc4b1614bd390b8e261dd4a2bd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:34:14 +00:00
Scott Rifenbark 638ad177aa bitbake: bitbake-user-manual: Added note for Python variable ref expansion.
Fixes [YOCTO #9148]

Added a note about Variable expressions (e.g. ${X}) are no longer
expanded within Python functions.

(Bitbake rev: 4ebe55cb8c8db1c5cf5d127e213487c5a453a68a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:34:14 +00:00
Scott Rifenbark da22add33b bitbake: bitbake-user-manual: Enhance environment variable discussion.
Fixes [YOCTO #8567]

Updated the variable list describing the variables that affect
how environment variables are handled.  Also updated the section
on how those variables are passed.

(Bitbake rev: 91cb52b1e77bba9d046239933b5c0513d01e6824)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:34:14 +00:00
Martin Samuelsson e82101a4ed bitbake: bitbake-user-manual-metadata: Updated 'dir' flag
Added more detail to the 'dir' flag to state the last
directory listed will be used as the work directory for the
task.

(Bitbake rev: 2fbd9e4e44f6b491cccca81fd34586fcfdeea3d3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:03:53 +00:00
Richard Purdie 69b6919341 bitbake: bitbake: Add explict getVar param for (non) expansion
Rather than just use d.getVar(X), use the more explict d.getVar(X, False)
since at some point in the future, having the default of expansion would
be nice. This is the first step towards that.

This patch was mostly made using the command:

sed -e 's:\(getVar([^,()]*\)\s*):\1, False):g' -i `grep -ril getVar *`

(Bitbake rev: 659ef95c9b8aced3c4ded81c48bcc0fbde4d429f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-23 11:57:53 +01:00
Scott Rifenbark 2f41470fd6 bitbake: bitbake-user-manual: Updated "Delete a Task" section for broken deps
Fixes [YOCTO #7803]

I added information for the scenario where deleting a task using the
deltask command could "break" implicit dependencies.

(Bitbake rev: 5ea3a206bb5beef4c12d56d9e42e29d324a08e16)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-22 16:52:33 +01:00
Scott Rifenbark cc63e1568b bitbake: bitbake-user-manual-metadata.xml: Alphabetized varflag list.
This list should have been in alphabetical order.  It is now.

(Bitbake rev: 9b7fae5c36c7b48237ce7903434602ebc1a07b20)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-12 12:14:14 +01:00
Scott Rifenbark 0e8f83fd92 bitbake: bitbake-user-manual-metadata.xml: Added two new varflag descriptions
Added brief descriptions for recideptask and lockfiles.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(Bitbake rev: ee52aa304680a27529264cb186df6936b0375118)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-12 12:14:14 +01:00
Scott Rifenbark 203aaaec08 bitbake: bitbake-user-manual: Cleaned up parallelism note and formatted user input
I updated the note in the second chapter that discusses the role for
BB_NUMBER_THREADS.  The updates make it a bit clearer.

Also scrubbed the manual for instances of user-supplied values to check
how they are being formatted.  I fixed the formatting to use the
<replaceable></replaceable> tags so they are in italics.

(Bitbake rev: e2879c60e905d7566091d40eab330372fa001313)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-17 13:28:47 +01:00
Scott Rifenbark 231d4a9d3d bitbake: bitbake-user-manual: Removed errant writer note line.
Removed a note to myself in the BB_ORIGENV example.

Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(Bitbake rev: 27848725316ddae619c1b86f8adc0bfecfadf413)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10 23:09:32 +00:00
Robert P. J. Day ec6377bcf5 bitbake: bitbake-user-manual-metadata.xml: Updated do_package_write example
Given that the "do_package_write" task doesn't exist in OE anymore,
steal another, existing example to demonstrate the "rdeptask" flag.

(Bitbake rev: 9e27bb2869e8ec6781d2f68d0585ebbf9ca6f3d8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 22:25:36 +00:00
Scott Rifenbark d5a808d6b3 bitbake: bitbake-user-manual-metadata.xml: Added [eventmask] flag information.
Reported-by: Laszlo Papp <lpapp@kde.org>
(Bitbake rev: 38150bc53c6bda5be7194f9acd112d362506d2ea)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09 22:25:36 +00:00
Scott Rifenbark 68eb17da93 bitbake: bitbake-user-manual-metadata.xml: Fixed variable flags example.
(Bitbake rev: 78b6c89931a78b2c722d2fcf61cf553b45566a5a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 09:30:01 +01:00
Scott Rifenbark d74b8824ae bitbake: bitbake-user-manual-metadata.xml: fixed some example whitespace issues
I added some whitespace to bring the example to use 5 spaces
rather than for so that it follows the manual's convention.

(Bitbake rev: 4c6e7d88d715db18e61bb263dfd2672ebb6c6b09)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:58 +01:00
Scott Rifenbark 335defe010 bitbake: bitbake-user-manual-metadata.xml: KERNEL_FEATURES example updated.
I added text to separate this example code from the general
BitBake User Manual's spirit of standing alone and away from
YP or OE stuff.  Also, added another space to move the examples
code so that 5 spaces are used for literal indentation.

(Bitbake rev: 17fcac8a7b21afa5c7d201e94cbf603ab07ba70c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:58 +01:00
Scott Rifenbark c723fa02f6 bitbake: bitbake-user-manual-metadata.xml: Fixed whitespace
I noticed that the examples from some patches were not indenting
by 5 spaces.  I have fixed these to be consistent.

(Bitbake rev: c487341bd20b70aae6b430ee1c74a7f20345f81a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Robert P. J. Day c08d72475c bitbake: bitbake-user-manual-metadata.xml: Removed fakeroot from list
"fakeroot" is now specified as a function attribute, not as a task
flag.

(Bitbake rev: 749b39a8e5e8060222c748a349efc31f541da94e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Robert P. J. Day eb169fe8b3 bitbake: bitbake-user-manual-metadata.xml: Added second conditional metadata example.
I think having a couple real-life examples here would make a huge
difference.

Comment from Scott: I modified the example description to indicate
that it is from an OpenEmbedded metadata-based recipe (i.e from
YP).  We have been trying very hard to keep the BitBake User
Manual as separate as possible from the YP docs.

(Bitbake rev: 834780772a08ecce7ed863e96d0674b47d0e589d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Robert P. J. Day 49627bbad3 bitbake: bitbake-user-manual-metadata.xml: Adding some flag examples.
As long as i've understood everything correctly, this is just
throwing in some physical examples of a couple concepts.

(Bitbake rev: a18cc69c2fef6484a6acd78ea008d1da71198e68)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Scott Rifenbark e83032ce0a bitbake: bitbake-user-manual-metadata.xml: Edits to some operators
Added wording to clearly state immediate or delayed application
for various operators.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(Bitbake rev: 877c4c9a466e26953abd6fe416c2cba092607dac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Robert Yang b62b682aef bitbake: bitbake-user-manual-metadata.xml: Replaced "populate_staging"
There is no "populate_staging" any longer, should be
"populate_sysroot".

(Bitbake rev: dbe5902e64259e2143f09ab1aa9afa03aa02f4c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 11:00:57 +01:00
Scott Rifenbark f1b9c7ea32 bitbake: bitbake-user-manual-metadata.xml: Added section on pathname syntax
Added a brief subsection to the "Basic Syntax" section that
describes the issue using the tilde character (~) when providing
a pathname as part of a statement.  BitBake does not expand
this character like the shell does.  We recommend to not use
it in pathnames.

(Bitbake rev: 8e4c5cee932c3f38d4147c59612d76ca0b002727)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark ea4e822b8d bitbake: bitbake-user-manual-metadata.xml: New section on anonymous Python functions
Per Paul Eggleton's suggestion, I added a new section on
anonymous Python functions into the "Functions" section.
I also updated the intro text to account for the added
type of functions.

(Bitbake rev: 983d03c1a082e2b83187f0788e61a7941670b242)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:19 +01:00
Scott Rifenbark 9889a91a5b bitbake: bitbake-user-manual-metadata.xml: Edits to flexible inheritance section.
Fixes [YOCTO #5472]

Applied review edits from Paul Eggleton to this section.
Minor edits and some re-writing.

(Bitbake rev: 7259d9d40aad8254751f7674653cd362a9023054)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:18 +01:00
Richard Purdie 392de9d568 bitbake: doc: Rename user-manual -> bitbake-user-manual
This manual gets combined with other manuals and in that context, it helps
a lot if its seen as the Bitbake User Manual. Renames are a pain but
this is worthwhile so that other docs can correctly be combined with this
one. This also clarifies things like google search results which is helpful.

(Bitbake rev: 452a62ae0c2793e281d6769fd3e45500a74898d6)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 23:03:18 +01:00