summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
AgeCommit message (Collapse)Author
2014-08-02bitbake: bitbake-user-manual-metadata.xml: Fixed variable flags example.Scott Rifenbark
(Bitbake rev: 78b6c89931a78b2c722d2fcf61cf553b45566a5a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-user-manual-fetching.xml: Minor edits to clearcase fetcherScott Rifenbark
(Bitbake rev: 33cd736d84eb8d4719e430450f26acaee5b31782) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-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. (Bitbake rev: 63f5a4b06a575e1fb18805b45a01549bffdc4a03) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-user-manual-fetching.xml: Added new clearcase fetcher module.Scott Rifenbark
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (Bitbake rev: dc669c4beda04ee88a50c9b48facfbd8cf17a331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23bitbake: "per-package" should say "per-recipe"Robert P. J. Day
(Bitbake rev: 1cd369883469747a8158826bb8d67dcca2a8577f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-22bitbake: Updated the the example 'bitbake -h' output to match the actual ↵Scott 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> (Bitbake rev: 8fbffd25d42f1f2d9a85ae1d9cc4852e835730d4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-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. (Bitbake rev: 4c6e7d88d715db18e61bb263dfd2672ebb6c6b09) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-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. (Bitbake rev: 17fcac8a7b21afa5c7d201e94cbf603ab07ba70c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-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. (Bitbake rev: c487341bd20b70aae6b430ee1c74a7f20345f81a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Removed fakeroot from listRobert P. J. Day
"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-21bitbake: bitbake-user-manual-metadata.xml: Added second conditional metadata ↵Robert P. J. Day
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-21bitbake: bitbake-user-manual-metadata.xml: Adding some flag examples.Robert P. J. Day
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-21bitbake: bitbake-user-manual-metadata.xml: Edits to some operatorsScott Rifenbark
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-21bitbake: bitbake-user-manual-execution.xml: Minor edits to execution chapter.Robert P. J. Day
(Bitbake rev: 8ff1b363df74f7e48da67fce9cf6b7e868c5e28e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-intro.xml: More edits to the intro chapter.Robert P. J. Day
Some applied as is, some not applied, some modified. (Bitbake rev: af98b2ff4f44f892b63a6598e7fdfc144972ed3d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-intro.xml: Minor edits to start of intro chapterRobert P. J. Day
(Bitbake rev: 4e5db4bc460c12194a233dd283c273009606bb64) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Replaced "populate_staging"Robert Yang
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-21bitbake: bitmake-user-manual-fetching.xml: Added transportuser parameter for SVNScott Rifenbark
Fixes [YOCTO #6475] A new parameter has been added to make sure the user is not passed as the username for the subversion commands with the SVN fetcher. (Bitbake rev: 366c70dbb0e9916f50ce1a4ff3ad4bd2757832a3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: templates: Added newline character to end of script.Scott Rifenbark
Prevents errors when editing in vi and writing and quiting. (Bitbake rev: 01692654cd792eaf6362bbac9c34314db4a7ffea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-ref-variables.xml: Edits to OVERRIDES variable.Scott Rifenbark
More detail. (Bitbake rev: 0ac8a504de1798dae02eb2dade2776e7e25d034d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-execution.xml: Minor fixes.Robert P. J. Day
Collection of typo and grammar fixes from "Execution" chapter. (Bitbake rev: ebca1b7847ff34213e6da71c79f00cb4b6b0757b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-intro.xml: Minor fixes mostly grammar adjustments.Robert P. J. Day
(Bitbake rev: fedc5470e9f4f5438d3de957f47985f76a484533) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-fetching.xml: Small fix in Git FetcherScott Rifenbark
Fixed how we refer to the "rev" paramater. (Bitbake rev: 90b1aec42cd29716f1cbd058757941cbfda235b0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-execution.xml: Typo and grammar fixes.Robert P. J. Day
(Bitbake rev: c469ceb86c1f76e9fa867ffb8a5c9b120ed7942b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-execution.xml: Edits to "Providers and Preferences"Scott Rifenbark
I split this section into two sections and tried to simplify what was being said about PROVIDES. (Bitbake rev: 394f64123d5ef1e9b4628d083488b9432eccbded) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-fetching.xml: Small wording change.Scott Rifenbark
(Bitbake rev: 66529a17d50bbce211361d98ace012b9424459c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-ref-variables.xml: Edits to PROVIDES variable.Scott Rifenbark
Added some more detail to help describe the variable. (Bitbake rev: 4b2019e67324f0f86e1a49d256eddb4f9ca597f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-style.css: Added permalink style for displayScott Rifenbark
Fixes [YOCTO #5772] Added a couple styles to the CSS style sheet so that the displayed permalink symbol is barely visible unless you hover over it with the mouse. (Bitbake rev: ee8db0cda1c8716ab0151a4859bfff84b2f3bd58) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-customization.xsl: Added support for variable ↵Scott Rifenbark
permalinks. Fixes [YOCTO #5772] Including the gloss-permalink.xsl file in the customization layer so that making the manual now generates permalinks for each variable definition in the glossary. (Bitbake rev: 04467594a599472c367365dffe205bf727c4d592) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: template: Added XSL template to support variable glossary permalinks.Scott Rifenbark
Fixes [YOCTO #5772] This file enables creation of permalinks for variables defined in the glossary. (Bitbake rev: 772f2bdc10fa242646e4d09f6bdbaf8558f06b22) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-intro.xml: Edits to "Obtaining BitBake"Scott Rifenbark
Updated the last bullet item that describes a final way to obtain a copy of BitBake. The example was too specific regarding Poky and OE. So, I made it quite generic and kept with the convention of not having any specific links from the BitBake manual into YP docs or such. (Bitbake rev: a2a3b534871aa23a5d442b93dd9660d5f9e27536) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-intro.xml: Basic proofreading, grammar fixes.Robert P. J. Day
(Bitbake rev: 266a0b5ef41dcc4048e2a4d1c43567568d7449d7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18bitbake: bitbake-user-manual-fetching.xml: Grammar, typo, and tweaks.Robert P. J. Day
Various grammatical and typo tweaks all in fetching chapter, including moving CVS section after wget section for more logical content flow. (Bitbake rev: 39bbc8f82894ca521d35645cd618dd131fde38ef) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18bitbake: bitbake-user-manual-style.css: Removed dead .PNG fileScott Rifenbark
Fixes [YOCTO #6430] I removed an old .PNG file that is not used. (Bitbake rev: dc5adbb8ce140b6898f18bb99bac02aac16f2ac8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18bitbake: bitbake-user-manual: Added permalink support.Scott Rifenbark
Fixes [YOCTO #5772] I added the five XSL templates to the template folder. I updated the bitbake-user-manual-customization.xsl layer file to include the new templates. (Bitbake rev: e1c24a79ededb2dd4ac5ce09fcfdf93218261907) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18bitbake: bitbake-user-manual-customization.xsl: Removed stale TOC variable.Scott Rifenbark
I deleted the commented out xsl:param line that attempts to set labeling for Appendices. It had been replaced by a working line. (Bitbake rev: bf79174e02cc113e0512bcadc3ab0fdffd138215) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18bitbake: bitbake-user-manual-fetching.xml: Edits to the Git Submodule ↵Scott Rifenbark
fetcher section. Exchanged "SRC_URI" for "URI" for clarity. (Bitbake rev: 90cc450671eaabf917c10a8d01b729b6bc0f544c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18bitbake: bitbake-user-manual-fetching.xml: Added new Git Submodule Fetcher ↵Scott Rifenbark
section. Added the "GIT Submodule Fetcher (gitsm://)" section to the fetchers chapter. This information was provided by Chris Morgan. Reported-by: Chris Morgan <chmorgan@gmail.com> (Bitbake rev: a3a3331e7118fd3139fe5a80b157a5a5b38631de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-19bitbake: fetch2/gitsm: Documentation improvements for gitsm:// fetcherChris Morgan
(Bitbake rev: ef2bf63e56b87e19d1a9059dd2d81a9a1a537254) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-hello.xml: Edits to the "Hello World" Appendix.Scott Rifenbark
Fixes [YOCTO #1973] These are review changes applied from Paul Eggleton. (Bitbake rev: 431181705f1bc3fc51439faa04a193debc1d03fd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-hello.xml: First draft of "Hello World" appendixScott Rifenbark
Fixes [YOCTO #1973] Added the complete "Hello World" appendix first draft beyond what Bill Traynor had supplied. (Bitbake rev: 176baaf3d0f033091f5ab9d9cfb2cec3d25a5442) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-hello.xml: Edits to environment for hello world.Scott Rifenbark
Some general edits to the sections that get you set up to run the "Hello World" example. (Bitbake rev: 43286d31c22e6e2fa96ba1b82445e85db0a0f18c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-metadata.xml: Added section on pathname syntaxScott Rifenbark
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-21bitbake: bitbake-user-manual-ref-variables.xml: Edits to the BBPATH variable.Scott Rifenbark
I took the stuff about running bitbake outside the build directory and removed the note syntax. (Bitbake rev: 783f29a593ce16a37b275b02f71b3ec918ef8c91) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-ref-variables.xml: Fixed BBPATH exampleScott Rifenbark
The example used in the note in the BBPATH variable description had incorrect syntax. Spaces existed in the BBPATH = statement. I have removed them. (Bitbake rev: 896a1c102a4afda0e5d07d009bd7918044f88269) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: user-manual-hello.xml: General editsScott Rifenbark
I worked through the chapter and made some minor edits based on my user experience. Part of what I did was to update the console output for the examples. (Bitbake rev: 13bf6cf71ff49572c3413435a33d87e5b6a8df0d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-hello.xml: Fixed two broken links.Scott Rifenbark
(Bitbake rev: 7a0948beba2c882de31ec9b98c7740bba230aed9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21bitbake: bitbake-user-manual-metadata.xml: New section on anonymous Python ↵Scott Rifenbark
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-21bitbake: bitbake-user-manual-metadata.xml: Edits to flexible inheritance ↵Scott Rifenbark
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-21bitbake: doc: Rename user-manual -> bitbake-user-manualRichard Purdie
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>