aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)Author
2018-05-24bitbake-user-manual: Updated copyright year on title page to 2018Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-04-12bitbake-user-manual: Updated "Task Checksums and Setscene" sectionScott Rifenbark
Fixes [#YOCTO 12030] Updated the "Task Checksums and Setscene" section to provide a bit of user information around the bitbake-dumpsigs use that lets a user examine signatures and inputs that determine if a do_compile task is indeed supposed to be run. Added more explanation of how a user can examine signatures used to determine if a do_compile task is indeed supposed to be run. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-04-12bitbake-user-manual: Updated "OpenEmbedded-Core" term.Scott Rifenbark
Made sure that the terms "OpenEmbedded-Core" and "OE-Core" are used as such throughout the manual. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-20bitbake-user-manual: Added cross reference to "Layers" section.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-20bitbake-user-manual: Updated BitBake help output due to runall command-line ↵Kristi Rifenbark
options. Fixed [YOCTO #12547] Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-09bitbake-user-manual: Added google-repo fetcher and REPODIR var.Nicolas Cornu
Added a new repo 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 REPODIR. Signed-off-by: Nicolas Cornu <nicolac76@yahoo.fr> Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-06bitbake-user-manual: Commented out Placeholder ParagraphKristi Rifenbark
Fixes [YOCTO #12030] Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake-user-manual: Removed stray parenthesisKristi Rifenbark
Fixes [YOCTO #12016] Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake-user-manual: Updated Hello World tutorialKristi Rifenbark
Fixes [YOCTO #12016] Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake-user-manual: Replaced bad linkKristi Rifenbark
Fixes [YOCTO #11675] There was a "hambedded" link that was broken. The link was intended to show the bitbake.conf file. I replaced it with the link to show the actual bitbake.conf file. Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake-user-manual: Updated copyright year.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake-user-manual: Updated 'bitbake -h' output example.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake-user-manual: Updated "Events" for BuildStarted eventScott Rifenbark
BitBake now fires off one "BuildStarted" event per configuration when it is configured for multiple configurations (multiconfig). I updated the bullet item for "bb.envent.BuildStarted()" to indicate that behavior. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-07bitbake-user-manual-metadata: include a space on a append exampleLeonardo Sandoval
By definition, the override operator "_append" does not include a space, so include it. Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-07bitbake-user-manual/bitbake-user-manual: remove YP as build systemLeonardo Sandoval
YP is not a build system, so it can not be used as build system example. Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06bitbake-user-manual: add more gitsm fetcher limitationsMikko Ylinen
The submodule sources fetched by the gitsm fetcher are not automatically tracked by the licensing and archiver infrastructures. Add these limitations to the existing 'warnings' sections for gitsm. [YOCTO #11594] Signed-off-by: Mikko Ylinen <mikko.ylinen@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26bitbake-user-manual: Updated kernel version in PREFERRED_VERSION exampleScott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13bitbake-user-manual: Edits to "inherit" section.Scott Rifenbark
Fixes [YOCTO #12031] Applied minor wording changes based on review feedback. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-09-13bitbake-user-manual: Removed bad linksScott Rifenbark
Fixes [YOCTO #12029] There were four links to an old blog post that was leveraged for the hello world example. The post has evidently been removed and the links no longer resolved. I have taken them out. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-09-13bitbake-user-manual: Updated inherit and INHERIT sectionsScott Rifenbark
Fixes [YOCTO #12031] Moved an inappropriate example from the bottom of the INHERIT Configuration Directive section up into the inherit directive section. Updated the example at the end of the INHERIT Configuration Directive section to apply to INHERIT. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-09-13bitbake-user-manual: Clarified inherit, include, require relationshipsScott Rifenbark
Fixes [YOCTO #12032] I applied some re-writing to help clarify the relationships between the inherit, include, and require directives. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-07-04bitbake-user-manual: Removed and replaced broken linkKristi Rifenbark
Fixes [YOCTO #11675] THere was a "hambedded" link that was broken. The link was intended to give additional information on adding layers. Replaced with link about layers and replaced the wording. Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-04bitbake-user-manual: Replaced bad linkKristi Rifenbark
Fixes [YOCTO #11675] There was a "hambedded" link that was broken. The link was intended to show the bitbake.conf file. I replaced it with the link to show the actual bitbake.conf file. Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-15bitbake-user-manual: Updated BBLAYERS_FETCH_DIR variable descriptionScott Rifenbark
Just discovered a minor issue in the bitbake manual - under the variable glossary entry for BBLAYERS_FETCH_DIR we say there's a default value of ${COREBASE} but that's not actually true in bitbake itself - there's no default in bitbake, that default is set in OE-Core. We can keep this in the YP ref manual but in the bitbake manual that sentence should be removed. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-09bitbake-user-manual-metadata.xml: fix a typoMing Liu
'buildCompleted' should be 'BuildCompleted'. Signed-off-by: Ming Liu <peter.x.liu@external.atlascopco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-21bitbake-user-manual: Updated INHERIT descriptionsScott Rifenbark
Fixes [YOCTO #11498] Enhanced the glossary description for the INHERIT variable to give more detail and to cross-reference the reader back into the Chapter 3 section describing its use. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-05fetch/local: Drop FILESDIRRichard Purdie
This has long since been deprecated and is no longer used anywhere, FILESPATH is the commonly used varaible which offers much more flexibility. Remove the FILESDIR code and references from bitbake. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-03bitbake-user-manual: Fixed special character in -D outputScott Rifenbark
Fixes [YOCTO #9962] The new output for -D was copied into the manual and merged by the engineering team before checking to see if the manual would make properly. The next output for -D introduced an error through the string "<task>". The angled bracket characters are illegal in docbook and must be replaced by "&lt;" and "&gt;", respectively. I made this fix. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-27main: Improve -v and -D option documentationDiana Thayer
Expanded and clarify documentation for the -v, --verbose and -D, --debug options. [YOCTO #9962] Signed-off-by: Diana Thayer <garbados@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01bitbake-user-manual: Added "path_spec" parameter to SVN FetcherScott Rifenbark
Fixes [YOCTO #10405] The section on the SVN Fetcher was missing information on the "path_spec" option. I added this option and also updated the examples at the bottom of the section to include that parameter. Also, made the other two examples consistent. I also removed the "date" parameter. Also, updated the "protocol" parameter as well as the "modify" parameter. For "modify" I removed the reference to "rsh". I applied a small wording change to the "protocol" parameter. Finally, I added a new "ssh" parameter. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-03-01bitbake-user-manual: Rewrite dependency dot file generationScott Rifenbark
The package-depends.dot and pn-depends.dot files are inaccurate, missing out key dependencies such those made via the [depends] flags. As such they can be misleading to the user. They mainly exist for historical reasons, coming from a time before we had task based execution. This commit removes the two dated file formats and replaces them with a recipe-depends.dot which is a flattened version of task-depends.dot. The old format files are removed if present so that the user can't get confused about why data might not match between files. The code is also rewritten to use 'with f: f.write()' syntax as is more commonly used now. Also update the docs to match the change. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19cooker: Rewrite dependency dot file generationRichard Purdie
The package-depends.dot and pn-depends.dot files are inaccurate, missing out key dependencies such those made via the [depends] flags. As such they can be misleading to the user. They mainly exist for historical reasons, coming from a time before we had task based execution. This commit removes the two dated file formats and replaces them with a recipe-depends.dot which is a flattened version of task-depends.dot. The old format files are removed if present so that the user can't get confused about why data might not match between files. The code is also rewritten to use 'with f: f.write()' syntax as is more commonly used now. Also update the docs to match the change. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19doc: Replace depexp UI with taskexp and cleanup UI listsRichard Purdie
The depexp UI has been replaced with taskexp, also remove old references to goggle and hob. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake-user-manual: Fixed small typo in "Events" sectionScott Rifenbark
There was a stra quote character after the word database and I removed it. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake-user-manual: Updated Event descriptionsScott Rifenbark
Fixes [YOCTO #10886] Added text descriptions for many of the events in the list of the "Events" section. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08bitbake-user-manual: Added new "Line Joining" section.Scott Rifenbark
Fixes [YOCTO #10444] Added a new section about syntax called "Line Joining". The section describes how you can use the backslash character (\) to joing stuff. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-12-08bitbake-user-manual: Refreshed the 'bitbake --help' output.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-11-30bitbake: remove True option to getVar callsJoshua Lock
getVar() now defaults to expanding by default, thus remove the True option from getVar() calls with a regex search and replace. Search made with the following regex: getVar ?\(( ?[^,()]*), True\) Signed-off-by: Joshua Lock <joshua.g.lock@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake-user-manual: Changed BB_SETSCENE_VERIFY_FUNCTION nameScott Rifenbark
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed to BB_SETSCENE_VERIFY_FUNCTION2. I changed the three areas in the book. Basically a name change. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-user-manual: Fixes small typos for 'addtask' sectionScott Rifenbark
Fixes [YOCTO #10401] Applied some edits to various areas of the section. These were minor in nature. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-user-manual: Updated the [noexec] and [nostamp] flag descriptionsScott Rifenbark
Fixes [YOCTO #10401] Added some wording to clarify that setting these flags to "1" causes the desired action. Also, provided a cautionary note about tasks depending on any [nostamp] task causes the task to always be executed and could cause unnecessary rebuild time. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-user-manual: Fleshed out the "addtask" documentationScott Rifenbark
Fixes [YOCTO #10401] The "addtask" documentation was rewritten to tighten up the introductory section and to flesh out the actual examples. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-user-manual: Updated the datastore functionsScott Rifenbark
Fixes [YOCTO #10400] No information existed for cases when a variable did not exist. I added this information to each of the variables in the table. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-06bitbake-user-manual: Added new section on BB-style functionsScott Rifenbark
Fixes [YOCTO #10364] Added a new section titled "Bitbake-Style Python Functions Versus Python Functions". This section describes differences for the user between the two types of functions. Also, cleaned up a consistency problem with the terms "BitBake style" and "BitBake-style". I used the latter throughout the manual. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake-user-manual: Updated minor wordings.Scott Rifenbark
Fixes [YOCTO #10296] Applied some minor wording changes per review edits. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake-user-manual: Added examples for using overrides with functions.Scott Rifenbark
Fixes [YOCTO #10296] This adds some bits clarifying you can append and prepend to functions. Added a bit to the introduction paragraph of the "Appending and Prepending (Override Style Syntax)" section to note that you can do this. Referenced some new examples. In the "Shell Functions" section I added an example. In the "BitBake Style Python Functions" section I also added an example. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake-user-manual: Fixed grammar from missing wordScott Rifenbark
Fixes [YOCTO #10293] I omitted the work "quote" and needed to have it there. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-21bitbake-user-manual: Added information for using single quotesScott Rifenbark
Fixes [YOCTO #10293] In the section about setting variables, I added a paragraph that explains the use of single quotes when setting a variable. The case covers when you must have the double quote charater as part of your variable's value. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-21bitbake-user-manual: New section on functions you can call from PythonScott Rifenbark
Fixes [YOCTO #10100] I added a new parent directory named "Functions You Can Call From Within Python". This section contains a couple new sub-sections. One is the existing "Functions for Accessing Datastore Variables". The other is called "Other Functions", and it is used to point or reference some commonly used functions that the user can call from within Python. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-02bitbake-user-manual: Added "Exporting Variables to the Environment"Scott Rifenbark
Fixes [YOCTO #10196] Added a new section named "Exporting Variables to the Environment". This section provides a dedicated description for how to export variables to the shell. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>