summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
AgeCommit message (Collapse)Author
2019-02-12bitbake: bitbake-user-manual: Fixed section head typoScott Rifenbark
Unseting -> Unsetting (Bitbake rev: 238a936f60cbffb73f7b370b867e45f91925951c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15bitbake: bitbake-user-manual: Added "usehead" parameter.Yong, Jonathan
(Bitbake rev: a9d361e39f110f6deecd1f35c425e0f0affcf828) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-31bitbake: bitbake-user-manual: Added hard-spacing to "_remove" example.Scott Rifenbark
Rendering the manual to its HTML form was collapsing the two leading and four trailing whitespace characters into single whitespace characters. I inserted multiple "&nbsp;" strings to force the spacing to come through. (Bitbake rev: 701f76f773a6e77258f307a4f8e2ec1a8552f6f3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29bitbake: bitbake-user-manual: Updates to variable wildcard support.Scott Rifenbark
Fixes [YOCTO #12390] Applied some fixes to the variable wildcard support documentation in the BitBake manual. Wording changes and changes to make links referencing Python syntax go to version 3 rather than version 2. (Bitbake rev: 0cfc71d1a342b82781b0ba547421e41f6340902a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29bitbake: bitbake-user-manual: Added wildcarding descriptionsScott Rifenbark
Fixes [YOCTO #12390] Added specific descriptions for how wildcarding works for a variety of variables and files (e.g. append files). (Bitbake rev: 0a4377cb1837ede213d9640344f4908de3689d91) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-18bitbake: bitbake-user-manual: fix description of BB_RUNTASKChris Laplante via bitbake-devel
Contrary to what the manual said, BB_RUNTASK does include the do_ prefix, unlike BB_CURRENTTASK. (Bitbake rev: 3f4968c77129252e8d0833fbd683372fca243a90) Signed-off-by: Chris Laplante <chris.laplante@agilent.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-18bitbake: data: Fix whitespace on _remove operationsRichard Purdie
We have some slightly odd behaviours with the current implementation of _remove operations. For example: TEST = " A B" TEST_remove = "C" would trigger TEST to become "A B" even thought it doesn't contain "C". In particular, this means that an inactive remove operator added in a bbappend could change the task checksum which is not desireable. Fix the operation to preserve whitespace, adding new tests to make this explict and test further corner cases. Also update the manual to match. (Bitbake rev: c0a23dd9155c50a6b7df796980bc7b612cac7994) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04bitbake: bitbake-user-manual: Added section on multicong dependenciesScott Rifenbark
Created a new section to show how to handle dependencies when you are doing a multiple configuration build. Put it in the "Examples" section. (Bitbake rev: fa42212a6cb7b64add4d6ca0f723a95c908c6b87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04bitbake: bitbake-user-manual: Added BBMULTICONFIG supportScott Rifenbark
The BBMULTICONFIG variable is a variable used for BitBake and was not documented in the BitBake Manual glossary. I added the definition. I also added the variable to the example in the section describing how to execute builds for multiple configurations. (Bitbake rev: 836f994ec530ba82c935cb41e006d1f128885dc2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04bitbake: bitbake-user-manual: Added new section on multiconfig buildsScott Rifenbark
Created a new example. Also added a figure for the separate configuration file hierarchy (Bitbake rev: f2d432674b187685591f60cec3b2980b377c63fe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-19bitbake: bitbake-user-manual: Added "number_threads" varflagScott Rifenbark
You can now limit on a task-specific basis the number of threads a task will use. This is useful for machines that have high numbers of cores and need to be rate-limited due to various resource constraints. (Bitbake rev: 4937ed392fdc4442dd91f644f329dda29f27242c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24bitbake: bitbake-user-manual: Updated copyright year on title page to 2018Scott Rifenbark
(Bitbake rev: 7799b17e7ac748e3639e5ab1e59b9b9c2a047bf6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-04-12bitbake: bitbake-user-manual: Updated "Task Checksums and Setscene" sectionuninative-1.9Scott 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. (Bitbake rev: 103bbc6642261cd5da038ba2071621919ee01253) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-04-12bitbake: bitbake-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. (Bitbake rev: 677e58f8616a4bf58772e54d2313af3885a3b110) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-20bitbake: bitbake-user-manual: Added cross reference to "Layers" section.Scott Rifenbark
(Bitbake rev: 34da85efb4cf76389f97d233571f79b733986ede) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-20bitbake: bitbake-user-manual: Updated BitBake help output due to runall ↵Kristi Rifenbark
command-line options. Fixed [YOCTO #12547] (Bitbake rev: 80de8c2369da5856b68458774ea63730063fcfa3) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14bitbake: bitbake-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. (Bitbake rev: 1cf084cee506574b7bb6ed03344597b3b2f2fe08) 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: bitbake-user-manual: Commented out Placeholder ParagraphKristi Rifenbark
Fixes [YOCTO #12030] (Bitbake rev: b2642e4d5adc765b205e73fee65da679add33ed0) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake: bitbake-user-manual: Removed stray parenthesisKristi Rifenbark
Fixes [YOCTO #12016] (Bitbake rev: a783bd7e457f183a279dbe5a4ef3d4c17bb4c18c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake: bitbake-user-manual: Updated Hello World tutorialKristi Rifenbark
Fixes [YOCTO #12016] (Bitbake rev: bc5b2e7e7fab53ee9ee0db762de822bb88062419) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake: bitbake-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. (Bitbake rev: ec0331cc039ab514d719ed34cec7a0a351c8d52b) 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: bitbake-user-manual: Updated copyright year.Scott Rifenbark
(Bitbake rev: da671cb4df0e1a00746c3e4ee94a4068fb5d9692) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake: bitbake-user-manual: Updated 'bitbake -h' output example.Scott Rifenbark
(Bitbake rev: 3e2a6f2a820482c360b66af777d9a38734b56c92) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16bitbake: bitbake-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. (Bitbake rev: 28720c85e64a56677b71d2170a0a07901d52b180) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-07bitbake: bitbake-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. (Bitbake rev: 6775e2de9067d8f472d7bfb5b78ec835a5688755) Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-07bitbake: bitbake-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. (Bitbake rev: dc86d38816aeb0fcbceb34cbaaa6ed98d33383e9) Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-07bitbake: bitbake-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] (Bitbake rev: ca10186d60a52af6464bd998fa0b7146513bed0e) Signed-off-by: Mikko Ylinen <mikko.ylinen@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26bitbake: bitbake-user-manual: Updated kernel version in PREFERRED_VERSION ↵Scott Rifenbark
example (Bitbake rev: 41ba3c8bfcd3501604f6a17bd327a8193b11b656) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13bitbake: bitbake-user-manual: Edits to "inherit" section.Scott Rifenbark
Fixes [YOCTO #12031] Applied minor wording changes based on review feedback. (Bitbake rev: f0930f3216a8358759d561d244fa280932e8bf05) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13bitbake: bitbake-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. (Bitbake rev: db298262189c94be700abfdb8c2ad7827b53afca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13bitbake: bitbake-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. (Bitbake rev: f169ac5da18d55a40d0554668e1a0ace70f94768) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13bitbake: bitbake-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. (Bitbake rev: fded970a0709d928f70224d8b61534e9353ee6dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-04bitbake: bitbake-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. (Bitbake rev: 877a1f476212dc151b74ce0f1febdc48956ef0e9) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-04bitbake: bitbake-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. (Bitbake rev: 3b8d101e564488ff1f5b27744404f9743da2b97d) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-15bitbake: bitbake-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. (Bitbake rev: 7b4e81772ed8789521661a3b32b576c91276ae34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-12bitbake: bitbake-user-manual-metadata.xml: fix a typoMing Liu
'buildCompleted' should be 'BuildCompleted'. (Bitbake rev: 9bd96cf938f746ace8d157f6b1b6c2550798085f) Signed-off-by: Ming Liu <peter.x.liu@external.atlascopco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-23bitbake: bitbake-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. (Bitbake rev: 362f6044fcaafe51ab4377af8f2606165b112717) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-05bitbake: fetch/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. (Bitbake rev: 751c9dc51fd01fa64a1ff37ba2638110335f71af) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-03bitbake: bitbake-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. (Bitbake rev: 0476ec4605c94b9e0208cfd3fa48ecf3e3f04181) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-27bitbake: main: Improve -v and -D option documentationDiana Thayer
Expanded and clarify documentation for the -v, --verbose and -D, --debug options. [YOCTO #9962] (Bitbake rev: 921592026c69287cdb40ffd90944d5944f28e2c3) Signed-off-by: Diana Thayer <garbados@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01bitbake: bitbake-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. (Bitbake rev: 3ce6169afa646ef2b847e5fbabfe0191c93928b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01bitbake: bitbake-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. (Bitbake rev: f82537d27f2a5bf9d576aa841593db9ec0985ea8) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19bitbake: cooker: 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. (Bitbake rev: d3e182bc18ff2894f1efc8aad3d508dd432c996e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19bitbake: doc: 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. (Bitbake rev: 814c2b232ea5f88b5ad5031fb9d389c9c594aa01) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake: bitbake-user-manual: Fixed small typo in "Events" sectionScott Rifenbark
There was a stra quote character after the word database and I removed it. (Bitbake rev: 50afcab054b2d93be96bfd3c224affebcab023cc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake: bitbake-user-manual: Updated Event descriptionsScott Rifenbark
Fixes [YOCTO #10886] Added text descriptions for many of the events in the list of the "Events" section. (Bitbake rev: e3b7e8430cb207756b59b32128aa3cef6a626fa1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08bitbake: bitbake-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. (Bitbake rev: a2768ecae7846d72a1bdb7cbbc5e8d242af854f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08bitbake: bitbake-user-manual: Refreshed the 'bitbake --help' output.Scott Rifenbark
(Bitbake rev: d7121d919beaa4be2c18d8f0bbd4afe01590eb7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-30bitbake: bitbake: 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\) (Bitbake rev: 3b45c479de8640f92dd1d9f147b02e1eecfaadc8) Signed-off-by: Joshua Lock <joshua.g.lock@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake: bitbake-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. (Bitbake rev: 41d9cd41d40b04746c82b4a940dca47df02514fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>