aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)Author
2016-07-21bitbake-user-manual: Added review changes to recursive section.Scott Rifenbark
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] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Addeds support for the Perforce FetcherAndrew Bradford
Added a new Perforce Fetcher section in the same spirit as the existing sections for other supported fetchers. Changes included the new section, removal of the bulleted item that mentioned this fetcher as an "additional" fetcher, and the creation of a new variable in the glossary named P4DIR. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Added clarifying note to BBCLASSEXTEND variable.Scott Rifenbark
Fixes [YOCTO #9909] Added a note that talks about how the BBCLASSEXTEND mechanism adds recipe variants. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Added a note providing examples of task dependenciesScott Rifenbark
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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Updated dependency section for tasksScott Rifenbark
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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Updated the defaults for getVar and getVarFlagScott Rifenbark
There is no default. Fixes [YOCTO #9683] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Added new section on command-line executionScott Rifenbark
Needed a section on executing a list of task and recipe combinations. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-05-18Provide LAYERDIR_RE for layer.confChristopher Larson
This variable is a regex-escaped version of LAYERDIR, for safer use in BBFILE_PATTERN, so as to avoid issues with regex special characters in the layer path. [YOCTO #8402] Signed-off-by: Christopher Larson <chris_larson@mentor.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18bitbake-user-manual: Updated the 'bitbake -h' output example.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18bitbake-user-manual: Updated "Conditional Metadata" sectionScott Rifenbark
Added information about using lower-case characters and no underscore characters when using OVERRIDES. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-14bitbake-user-manual: Updated discussion about using "inherit"Scott Rifenbark
Fixes [YOCTO #9343] I updated the inherit directive section to note that you can inherit multiple classes using a single line. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23bitbake-user-manual: include/require checks current directoryScott Rifenbark
I added wording to note that include/require checks the current directory in addition to BBPATH Fixes [YOCTO #8566] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-23bitbake-user-manual: Updated the "inherit Directive" section.Scott Rifenbark
Fixes [YOCTO #9283] Updated the description to document conditional inherits. Provided several examples. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-23bitbake-user-manual: Updated the copyright year to 2016Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-03bitbake-user-manual: Added expand() function to list.Scott Rifenbark
Fixes [YOCTO #9147] Added the d.expand(expression) fuction to the list of functions in the "Accessing Datastore Variables Using Python" section. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-03bitbake-user-manual: Added note for Python variable ref expansion.Scott Rifenbark
Fixes [YOCTO #9148] Added a note about Variable expressions (e.g. ${X}) are no longer expanded within Python functions. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-03bitbake-user-manual: Enhance environment variable discussion.Scott Rifenbark
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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-01-29bitbake-user-manual-ref-variables: Update the help for BBMASKPeter Kjellerstedt
Update the help for BBMASK to reflect that it is now allowed to contain multiple regular expressions. Also changed the examples for BBMASK to be a bit more diverse. Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29bitbake-user-manual-metadata: Updated 'dir' flagMartin Samuelsson
Added more detail to the 'dir' flag to state the last directory listed will be used as the work directory for the task. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29bitbake-user-manual: Updated the example BitBake directoryScott Rifenbark
This directory no longer has setup.py as part of the directory. I removed that line from the example in the "Obtaining BitBake" section. Fixes YOCTO #8623 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29bitbake-user-manual: Added new description for BB_TASK_IONICE_LEVELScott Rifenbark
Added a new variable description here for this variable. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29bitbake-user-manual: Added BBTARGETS variable description.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-08-01bitbake-user-manual-fetching.xml: note about URLs with semi-colonsJuro Bystricky
Some URLs contain semi-colons. Unfortunatelly, bitbake uses semi-colons in SRC_URI as delimiters for various parameters. It may still be possible to use such URLs, providing the user replaces semi-colons ';' with '&' characters. For example: http://abc123.com/git/?p=gcc/gcc.git;a=snapshot;h=a5dd47 and http://abc123.com/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47 should be equivalent, as W3C recommends treating ';' in queries identically to '&'. See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.2.2 Kudos to Olof Johansson Signed-off-by: Juro Bystricky <juro.bystricky@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-19bitbake: Add explict getVar param for (non) expansionRichard Purdie
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 *` Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-19bitbake-user-manual-ref-variables: Added BBLAYERS_FETCH_DIR glossary item.Trevor Woerner
Add BBLAYERS_FETCH_DIR to the Variables Glossary. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-16bitbake-user-manual-ref-variables.xml: Added BB_ALLOWED_NETWORKS desc.Scott Rifenbark
Added a new variable description for the BB_ALLOWED_NETWORKS variable. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-22bitbake-user-manual: Updated "Delete a Task" section for broken depsScott Rifenbark
Fixes [YOCTO #7803] I added information for the scenario where deleting a task using the deltask command could "break" implicit dependencies. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-19bitbake-user-manual-customization.xsl: Pointing to mirrors for XSL files.Scott Rifenbark
Instead of pointing to the Sourceforge area, which seems to flake out every so often, we are now pointing to a mirror to get the XSL files needed to build the manual. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-12bitbake-user-manual-metadata.xml: Alphabetized varflag list.Scott Rifenbark
This list should have been in alphabetical order. It is now. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-12bitbake-user-manual-metadata.xml: Added two new varflag descriptionsScott Rifenbark
Added brief descriptions for recideptask and lockfiles. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-17bitbake-user-manual: Cleaned up parallelism note and formatted user inputScott Rifenbark
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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake-user-manual: Removed errant writer note line.Scott Rifenbark
Removed a note to myself in the BB_ORIGENV example. Reported-by: Paul Eggleton <paul.eggleton@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake-user-manual: Added some links to some new variables.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake-user-manual: Added five new repo variables and links.Scott Rifenbark
Added the following variables to the glossary: CVSDIR GITDIR SVNDIR HGDIR BZRDIR Several areas in the main manual mentioned these variables. For each, I added the appropriate link to the glossary term. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10Makefile: Updated the script to not create PDF version by defaultScott Rifenbark
For this release, we are dropping automatic creation of PDF manual. The user can still create them by specifically using the 'pdf' target. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bitbake-user-manual-metadata.xml: Updated do_package_write exampleRobert P. J. Day
Given that the "do_package_write" task doesn't exist in OE anymore, steal another, existing example to demonstrate the "rdeptask" flag. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bitbake-user-manual-metadata.xml: Added [eventmask] flag information.Scott Rifenbark
Reported-by: Laszlo Papp <lpapp@kde.org> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bitbake-user-manual: Updated copyright to 2015.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-06bitbake: Make printed 'runqueue' be consistently capitalizedGary Thomas
This has always bothered me: NOTE: Preparing runqueue NOTE: Executing RunQueue Tasks This patch changes the messages to be consistent. Signed-off-by: Gary Thomas <gary@mlbassoc.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-01bitbake-user-manual-metadata.xml: Fixed variable flags example.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-08-01bitbake-user-manual-fetching.xml: Minor edits to clearcase fetcherScott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-08-01bitbake-user-manual/bitbake-user-manual-intro.xml: Fixed linkScott Rifenbark
I inadvertantly used a &YOCTO_* variable in the book to get a link to the landing YP page. Of course this does not work. I replaced it with the actual URL. Unfortunately, a previous commit slipped through that would have prevented the manual from "making" correctly. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-08-01bitbake-user-manual-fetching.xml: Added new clearcase fetcher module.Scott Rifenbark
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-07-23"per-package" should say "per-recipe"Robert P. J. Day
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-22Updated the the example 'bitbake -h' output to match the actualScott Rifenbark
output, which has been recently patched to fix the '-S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER' option. Note also, that I have added a new option that has since appeared in the output but was not in the manual's example. That option added is '--token=XMLRPCTOKEN'. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-07-21bitbake-user-manual-metadata.xml: fixed some example whitespace issuesScott Rifenbark
I added some whitespace to bring the example to use 5 spaces rather than for so that it follows the manual's convention. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-07-21bitbake-user-manual-metadata.xml: KERNEL_FEATURES example updated.Scott Rifenbark
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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-07-21bitbake-user-manual-metadata.xml: Fixed whitespaceScott Rifenbark
I noticed that the examples from some patches were not indenting by 5 spaces. I have fixed these to be consistent. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-07-21bitbake-user-manual-metadata.xml: Removed fakeroot from listRobert P. J. Day
"fakeroot" is now specified as a function attribute, not as a task flag. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-07-21bitbake-user-manual-metadata.xml: Added second conditional metadata example.Robert P. J. Day
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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>