Commit Graph

277 Commits

Author SHA1 Message Date
Robert P. J. Day 696973af24 bitbake: bitbake-user-manual-intro.xml: More edits to the intro chapter.
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-21 11:00:57 +01:00
Robert P. J. Day 4df50d3827 bitbake: bitbake-user-manual-intro.xml: Minor edits to start of intro chapter
(Bitbake rev: 4e5db4bc460c12194a233dd283c273009606bb64)

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 435e425976 bitbake: bitmake-user-manual-fetching.xml: Added transportuser parameter for SVN
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-21 11:00:56 +01:00
Scott Rifenbark 49b416dde5 bitbake: templates: Added newline character to end of script.
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-03 13:58:57 +01:00
Scott Rifenbark 70439569c8 bitbake: bitbake-user-manual-ref-variables.xml: Edits to OVERRIDES variable.
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-03 13:58:57 +01:00
Robert P. J. Day 0b96a4ba62 bitbake: bitbake-user-manual-execution.xml: Minor fixes.
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-03 13:58:57 +01:00
Robert P. J. Day 538cbf4932 bitbake: bitbake-user-manual-intro.xml: Minor fixes mostly grammar adjustments.
(Bitbake rev: fedc5470e9f4f5438d3de957f47985f76a484533)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark ac8ac1724d bitbake: bitbake-user-manual-fetching.xml: Small fix in Git Fetcher
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-03 13:58:56 +01:00
Robert P. J. Day 3a7258afd5 bitbake: bitbake-user-manual-execution.xml: Typo and grammar fixes.
(Bitbake rev: c469ceb86c1f76e9fa867ffb8a5c9b120ed7942b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark 00ade7ecd0 bitbake: bitbake-user-manual-execution.xml: Edits to "Providers and Preferences"
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-03 13:58:56 +01:00
Scott Rifenbark 0736649c57 bitbake: bitbake-user-manual-fetching.xml: Small wording change.
(Bitbake rev: 66529a17d50bbce211361d98ace012b9424459c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:56 +01:00
Scott Rifenbark 157c80f488 bitbake: bitbake-user-manual-ref-variables.xml: Edits to PROVIDES variable.
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-03 13:58:56 +01:00
Scott Rifenbark 41b46d7826 bitbake: bitbake-user-manual-style.css: Added permalink style for display
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-03 13:58:56 +01:00
Scott Rifenbark d3e1ce60b1 bitbake: bitbake-user-manual-customization.xsl: Added support for variable 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-03 13:58:56 +01:00
Scott Rifenbark dd09b077c0 bitbake: template: Added XSL template to support variable glossary permalinks.
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-03 13:58:56 +01:00
Scott Rifenbark ca77f37bf8 bitbake: bitbake-user-manual-intro.xml: Edits to "Obtaining BitBake"
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-03 13:58:55 +01:00
Robert P. J. Day 296bb748f6 bitbake: bitbake-user-manual-intro.xml: Basic proofreading, grammar fixes.
(Bitbake rev: 266a0b5ef41dcc4048e2a4d1c43567568d7449d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:58:55 +01:00
Robert P. J. Day 5b1c329804 bitbake: bitbake-user-manual-fetching.xml: Grammar, typo, and tweaks.
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-18 13:48:39 +01:00
Scott Rifenbark 8be77bb03f bitbake: bitbake-user-manual-style.css: Removed dead .PNG file
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-18 13:48:38 +01:00
Scott Rifenbark 74551392b3 bitbake: bitbake-user-manual: Added permalink support.
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-18 13:48:38 +01:00
Scott Rifenbark c65de86d81 bitbake: bitbake-user-manual-customization.xsl: Removed stale TOC variable.
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-18 13:48:38 +01:00
Scott Rifenbark d87cb56aa8 bitbake: bitbake-user-manual-fetching.xml: Edits to the Git Submodule 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-18 13:48:38 +01:00
Scott Rifenbark 77166a2a88 bitbake: bitbake-user-manual-fetching.xml: Added new Git Submodule Fetcher 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-06-18 13:48:38 +01:00
Chris Morgan 09edf20070 bitbake: fetch2/gitsm: Documentation improvements for gitsm:// fetcher
(Bitbake rev: ef2bf63e56b87e19d1a9059dd2d81a9a1a537254)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-19 12:04:34 +01:00
Scott Rifenbark 57e8d56a6b bitbake: bitbake-user-manual-hello.xml: Edits to the "Hello World" Appendix.
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-21 23:03:19 +01:00
Scott Rifenbark 61a680fb5d bitbake: bitbake-user-manual-hello.xml: First draft of "Hello World" appendix
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-21 23:03:19 +01:00
Scott Rifenbark 4687351d16 bitbake: bitbake-user-manual-hello.xml: Edits to environment for hello world.
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-21 23:03:19 +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 ef7fac5bba bitbake: bitbake-user-manual-ref-variables.xml: Edits to the BBPATH variable.
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-21 23:03:19 +01:00
Scott Rifenbark 45880c7235 bitbake: bitbake-user-manual-ref-variables.xml: Fixed BBPATH example
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-21 23:03:19 +01:00
Scott Rifenbark 8f4b4e6f31 bitbake: user-manual-hello.xml: General edits
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-21 23:03:19 +01:00
Scott Rifenbark 1313bacfbe bitbake: bitbake-user-manual-hello.xml: Fixed two broken links.
(Bitbake rev: 7a0948beba2c882de31ec9b98c7740bba230aed9)

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
Scott Rifenbark a5775abb19 bitbake: user-manual-metadata.xml: Added new section on mapping functions.
Fixes [YOCTO #5472]
Fixes [YOCTO #1973]

Created a new section called "Automatically Mapping Functions
Within the Context of a Class".  This section addresses the
EXPORT_FUNCTIONS "operator", which was the last of the adjustments
to the variables bug against the BB manual (1973).  The related
bug (5472) is a general bug against enhancing the BB manual, which
this change caps off.

The section here was reviewed and approved by Richard Purdie.

(Bitbake rev: cec33d4fdc05db3a41e978f3a1ab977730c443eb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-02 14:15:35 +01:00
Scott Rifenbark 790cc61a75 bitbake: user-manual-execution.xml: Added how BB processes curly braces.
(Bitbake rev: f4ebc4de63d64e3b5f87e1d0f51507760c3d82d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:19:49 +01:00
Scott Rifenbark 34f4a9d8b7 bitbake: user-manual-execution.xml: Updated "Checksum (Signatures) section.
Fixes [YOCTO #5357]

Added a paragraph at the end of this section to address the fact
that the user can now debug Bitbake's processing of signatures.
This introduces the -S bitbake option and the fact that the
user can provide a couple parameters with it: "none" and
"printdiff".

(Bitbake rev: 4093fa6c96eebe0bbafb93dc27d8a978cca436c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:19:49 +01:00
Scott Rifenbark e7277a53ed bitbake: user-manual-intro.xml: updated bitbake -h output
The new -S syntax is in there now.

(Bitbake rev: 5a406a69c14b6ddf179fea2c4bc68cddf9eddeea)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:19:49 +01:00
Scott Rifenbark 843e3ecf9e bitbake: user-manual-metadata.xml: Added varflag for vardepvalueexclude.
Fixes [YOCTO #5897]

Added several new varflags to the existing list in the
"Variable Flags" section.  The key one being the
"vardepvalueexclude" flag.

(Bitbake rev: 01a07dabb0d0c6a7f8c3c048396cfdf9d756b032)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 13:23:06 +00:00
Scott Rifenbark 37f7820d4d bitbake: user-manual-metadata.xml: Edits to "Basic Variable Setting"
Fixes [YOCTO #5507]

I applied some edits from Richard's review to the fix for
handling variable setting.  Moved the new section I created into
the existing "Basic Variable Setting" section.

(Bitbake rev: 0d63589abfa6b353f3b456a9a91de4dd98eb3965)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 13:23:06 +00:00
Scott Rifenbark c0a13d21cf bitbake: user-manual-metadata.xml: Sections to handle variable setting added.
Fixes [YOCTO #5507]

I provided further explanation in the "Basic Variable Setting"
section to note that trailing and leading blanks are not stripped
from a value when set (e.g. VARIABLE = " value").

I added a new section "Null and Blank Setting" explaning that setting
a variable to "" and " " are two different things.

(Bitbake rev: 96d0b38577476a3576487f1fa9a4b6c9dff5d3ed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 13:23:06 +00:00
Scott Rifenbark 019c868596 bitbake: Makefile: Added publish tag so the book can be published.
(Bitbake rev: a895f76836c867822f5be33546e51b285e7016e0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 13:23:05 +00:00
Scott Rifenbark da6926bc6a bitbake: user-manual: Review edits applied throughout from Paul Eggleton.
Applied review edits from Paul Eggleton spanning the entire book.
Small areas affected in all chapters except the "Hello World"
Appendix.

Noteworthy changes in the variables chapter where I added two new
variables: BBINCLUDELOGS_LINES and BB_CONSOLELOG.

(Bitbake rev: 2d4b09be70c6df0c1605f7e291149c682999cf50)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark 40ab940360 bitbake: user-manual: Review edits applied from Paul Eggleton.
Review of the entire manual by Paul.  I have implemented his
suggestions throughout.

(Bitbake rev: 5cd310d1df194cd171691a4bcfb98024e2bc66b8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark 96294ee407 bitbake: user-manual: removed SVK references - all types.
(Bitbake rev: fbbd4cd54753a5d91b5c342d60d007bd2b172570)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark ead6001316 bitbake: user-manual-ref-variables.xml: Edits to BB_GENERATE_MIRROR_TARBALLS variable
Added some clarification around who would like to set this
variable and why.

(Bitbake rev: 97acce37528ed11165e37996c7076de46c349b0a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark c390221fc8 bitbake: user-manual-metadata.xml: Added BB_ORIGENV example.
(Bitbake rev: d4328e2df355252870c3bf01031538a77795cedb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark 74d2a10871 bitbake: user-manual-metadata.xml: Grammar fix.
(Bitbake rev: 71e314b86957ecc01d77262d0a000f6f31db2bcc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark 197e7e35ca bitbake: user-manual-execution.xml: Review edits for "Execution" chapter.
Applied various changes from Richard Purdie's review of the
"Execution" chapter.

(Bitbake rev: 714c0e93bc2d1ae6227991a1c6e4c88504c1870c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark c5095104aa bitbake: user-manual: Review edits from Richard (second draft)
Applied the comprehensive set of review comments from Richard
Purdie.  All files affected.  One major point here was that the
"BitBake Command" chapter was eliminated.  This information was
folded into various areas of the book.  Consequently, the bits
including the file for make had to be updated.

(Bitbake rev: 8ec38c6b456a92a0e0b9b04c2793a5b148be5027)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07:00
Scott Rifenbark 4cd882b9d0 bitbake: user-manual: Added "Hello World" Appendix.
I took Bill's chapter and made it into an appendix.  I did some
re-writing to make it not so much like a getting-started feel,
although it still leans way that way for an appendix.  The content
is not complete.

Had to add in a line to the user-manual.xml file so that the
new appendix would be part of the book.

Had to use a different form of the command in the
user-manual-cusomization.xsl file in order to not through a bunch
of errors for an unrecognized parameter value.  I commented out
the existing one.

(Bitbake rev: 80e9306c288ca2ab42585f99fb0f396253cb8253)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark 9b3e31e5e1 bitbake: user-manual-fetching.xml: Re-write of the Fetching chapter.
Based on a Richard Purdie re-write.

(Bitbake rev: fad9a6258f8c04bbe0168e46898dd27b86c39ee0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark cd0c0673dc bitbake: user-manual-metadata.xml: Title change, sections lifted.
Changed the title of the chapter to "Syntax and Operators".  It
was called "Metadata".

Removed the bulk the "Checksums (Signatures)" section and the
placeholder for "Setscene".  These are now in the "Execution"
chapter.

Created a more appropriate overview blurb to start the chapter.

(Bitbake rev: f955171d8468ed987f92146d39f52d9af4a03dbb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark b82b3d2cc3 bitbake: user-manual-fetching.xml: Removed a link.
The link no longer applied as it was linking to a removed
section from the "Execution" chapter.

(Bitbake rev: de1c316a3f5f382c66b58ad2539b4fadb0f000db)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark 3801023615 bitbake: user-manual-execution.xml: Review edits applied.
Significant review changes implemented from Richard Purdie.

* Eliminated the lifted text from the "Closer Look" chapter
  of the YP ref-manual.

* Added the "BitBake" chapter in from the YP ref-manual.

* Significant re-writes and suggestions throughout the
  entire chapter.

(Bitbake rev: 4a740385a4720e040af3d329d9c7cc77b03e7f46)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark 9996f31af4 bitbake: user-manual-intro.xml: Review edits to Introduction chapter.
Applied review edits to the introduction chapter as suggested
by Richard Purdie.

(Bitbake rev: c6c912cf875766036b91af785f257f64ff07146c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark 0c5bf41968 bitbake: user-manual-execution.xml: Draft of "Execution" chapter
This is a rough draft of the chapter.  Major sections are in
place.  We need to scrub content now.

Seems like the discussion of BBFILES fit better in this
execution flow chapter.  So, I moved it above the parsing
section.

(Bitbake rev: 6c4c6fb689b88dbefe63f0062b78d8403fb80d41)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark 013c9d9181 bitbake: user-manual-intro.xml: Added sections
Added the append files and layer subsections.

(Bitbake rev: 38c3ead4ac8036ac88e83a938aa4ce484d4a6a84)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:03 -07:00
Scott Rifenbark 117726cef4 bitbake: user-manual-bitbakecommand.xml: Added anchor tag for the chapter.
(Bitbake rev: 5aa6679aa8b5b6b8bf4b43cabde04072498ccea4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark f3caa2b27e bitbake: user-manual-fetching.xml: Re-write of "File Download Support" chapter.
Basic re-write to clean up text and flow.

(Bitbake rev: 0f82dc4c22ce015bef87fd5aae0b6fa3e429016e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark b4b3bf56f6 bitbake: user-manual: Added new chapter to cover BB execution.
This commit added need files, cleaned up bogus links, and
adjusted the build file, which is user-manual.xml.

The new chapter file is "user-manual-execution.xml". The file
has base text from the bitbake section from the "Closer Look"
chapter of the YP ref-manual.  This means that I had to initially
include some figures from that book for now.  I am not including
them as part of this commit though as they will likely get renamed.
I made sure that all links were removed that were specific to the
YP ref-manual.

Another change was in the user-manual.xml file to include
the new chapter as part of the build.

Another block of text for the new chapter was the "Running a Task"
section from the user-manual-metadata.xml file.  Consequently, that
section was deleted from the "Metafile" chapter.

Another block of text for the new chapter was the "Parsing
and Execution" section from the user-manual-metadata.xml file.
Consequently, that section was deleted from the "Metafile chapter.

(Bitbake rev: f3b21d1fb711f9625d2ac92d4f4fe0f269242bd7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark 34bcd96796 bitbake: user-manual-intro.xml: Added an introduction to the manual.
Describes purpose and qualifies some stuff.

(Bitbake rev: b9704a367cccd85931fa4fb779d273a27361d503)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark 8aaff2570c bitbake: user-manual-ref-variables.xml: Added a note qualifying the variables.
The note provides some information in general about the variables
that are part of the glossary.

(Bitbake rev: 8bcc6d1f1ef4e647ad6153ed7a9e0bd5bc62cf0b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark 0510569b8c bitbake: user-manual-metadata.xml: WIP - Some edits in the checksum area.
(Bitbake rev: f74045d9ac88aece1d6f8d6a95389d01971ffdac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark 1d9c02e878 bitbake: user-manual-metadata.xml: Rewrite "Accessing Datastore Variables Using Python"
Rewrote this section.  Used a table instead of the funky list
that was there.  I still need to format it some.

Also fixed up the term "datastore".  It should not be "data store"

(Bitbake rev: ee23839596102ccd58e028c10471438f2eb37feb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark 666a7b0924 bitbake: user-manual-metadata.xml: Re-write the "Dependencies" section.
General edits and dumping of the useless "Overview" section.

(Bitbake rev: b11ad97b9334a86b2f3b10bdf5597910854475bd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:02 -07:00
Scott Rifenbark bfafc2fc3c bitbake: user-manual-metadata.xml: Re-write of "Variants - Class Extension Mechanism" section.
Some general rewrites here.

(Bitbake rev: 7149ab6f6e936c19d681f05aa64b123c10f2f3da)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark 3940d59e64 bitbake: user-manual-ref-variables.xml: Added BBVERSIONS variable.
(Bitbake rev: 0ee8e8db8475903754d519c5e6d7ec8e52ba9c85)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark 233d644e5a bitbake: user-manual-metadata.xml: Re-write of "Events" section.
General cleanup of the text.

(Bitbake rev: 112dd4279826dc7587e1b8acb4a107374b5bd0fd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark c0239ff8a8 bitbake: user-manual-metadata.xml: General cleanup to "Parsing and Execution"
I went through and created links for variables we reference that
are in the glossary.  I also re-wrote much of the text to just
clean it up.

(Bitbake rev: dd9a4422d387da45f6de945eb4944c2a06bc98a0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark 80127f433a bitbake: user-manual-metadata.xml: Edits to "Variable Flags" section
Worked through this section with Richard providing an interactive
review.  The changes are after the review.  There was also a
small edit to the "Tasks" section.

(Bitbake rev: cba57f8d900d7c3ed8da9fcab0697e3047476325)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark ae96cbb4c4 bitbake: user-manual-metadata.xml: Rewrite of the "Tasks" section.
I cleaned up this section with some general improvements.

I also broke this up into a couple sub-sections where it seemed
to logically fall.  Also, stole some metadata concept from the
next section ("Running Tasks") that really should be lumped under
"Tasks".

(Bitbake rev: 9673acda2239807e31f4fcda1574b3e5e2d013a6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark faaca84d6e bitbake: user-manual-metadata.xml: Rewrite of the "Functions" section.
Re-organized this around the 3 types of functions that we seem
to be show-casing here.  The original organization was not very
good.

(Bitbake rev: 77ef63e5c4a9ea633a1be0f9f90366e0ecf555fa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:01 -07:00
Scott Rifenbark d022ec3ff5 bitbake: user-manual-ref-variables.xml: Edits to SRC_URI.
(Bitbake rev: b8472f81387f8b8110cd560d61a4563d53d26859)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:00 -07:00
Scott Rifenbark 6f8f51f3b6 bitbake: user-manual-ref-variables.xml: Edits to BBCLASSEXTEND.
(Bitbake rev: bc2a13ba86a5e01b457209b72608403e6aa12003)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:00 -07:00
Scott Rifenbark 1e305eca4e bitbake: user-manual-metadata.xml: Edits to "Sharing Functionality"
Applied some review edits from Paul to the section.

(Bitbake rev: f4dc71a3ff2c7f2ca6093b751883a1244f8d3847)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:00 -07:00
Richard Purdie dc42d886ba bitbake: user-manual-metadata.xml: Add bare bones of a scheduler section
(Bitbake rev: cf0ccb26cc7af9f29704bb4c7ada6bf8ef5b0ee6)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:00 -07:00
Richard Purdie 624e59ff77 bitbake: user-manual-metadata.xml: Add details about general variables used by BitBake
(Bitbake rev: 7e78785a53e259225b632c161a70d82fe66eb672)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:00 -07:00
Richard Purdie bd23241655 bitbake: user-manual-metadata.xml: Add details about environment variables used by BitBake
(Bitbake rev: 91d3e60a48d2269adfd0084eb6f1bcdb211dbce1)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:00 -07:00
Scott Rifenbark 9c61b6392c bitbake: user-manual-metadata.xml: Edits to the "Sharing Functionality" section.
Applied some review edits from Paul to the section.

(Bitbake rev: 56321b18808f5ed932543d907b9ebcfbf4420233)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark d110f55a94 bitbake: user-manual-metadata.xml: Edits to "Conditional Syntax (Overrides)"
Re-wrote this section to use clearer more described examples.

(Bitbake rev: 6eea23c4783c591c2d2c7f0b2a98e7a0cc8aa3c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark decc756e89 bitbake: user-manual-metadata.xml: Edits to "Defining Pure Python Functions"
Made a review edit here to the section per Paul Eggleton.

(Bitbake rev: 3b6ab095862367bc0101b995b002f62e7968ccf3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark 2fc9281c49 bitbake: user-manual-metadata.xml: Edits through syntax section
I made some general improvements in the "Overview" and
"Basic Syntax" sections.  Additionally, I added a blank
section for "Variable Flags" that will eventually hold general
information on this concept.  Finally, come review edits to the
"Defining Pure Python Functions" section per Paul Eggleton.

(Bitbake rev: 665d655f436f1a353f5fe467c5d97588f7b121c5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark a2e5746f29 bitbake: user-manual-intro.xml: General edits to Introduction chapter.
I performed a general edit to this chapter.  Some significant changes
include changing the chapter's title to "Overview" when it was titled
"BitBake User Manual", doing some consolidation of text to eliminate
a couple sections that described methods to obtain a copy of BitBake,
and various improvements as needed.

(Bitbake rev: f635c4b36af79b8572095083a392fb58c11198c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark 3cdf800334 bitbake: user-manual-metadata.xml: Added "Checksums (Signatures)" section.
Added this section to the end of the Metadata chapter.

(Bitbake rev: b653c58284cafd0b79991520543ca6239705d36b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark 89058e1ef7 bitbake: user-manual-ref-variables.xml: Review edits to several variables in glossary.
ASSUME_PROVIDED
BBCLASSEXTEND
SRC_URI
PACKAGES_DYNAMIC
BB_NUMBER_THREADS
BB_DANGLINGAPPENDS_WARNONLY

(Bitbake rev: 8e586ccee6d5e78070d28cda67058578e1fe91d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:06 +00:00
Scott Rifenbark ddcd91c6d6 bitbake: user-manual-ref-variables.xml: Added 11 new variables to glossary.
SRCREV_FORMAT
BUILDNAME
BB_ENV_WHITELIST
BB_PRESERVE_ENV
BB_ENV_EXTRAWHITE
BB_ORIGENV
BB_TASKHASH
BITBAKE_UI
BBDUBUG
BB_DEFAULT_TASK
BBINCLUDED

(Bitbake rev: 0e3106bfdebfa255b2db08a8a4585516d8bebe20)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Scott Rifenbark 081d31c6bc bitbake: user-manual-ref-variables.xml: Edits to FILESPATH.
(Bitbake rev: 64bdd3ba6fe90ed6e0338ad053c8117db0acfe2e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Scott Rifenbark 825366d7f0 bitbake: user-manual-ref-variables.xml: Added 6 new variables to glossary:
MULTI_PROVIDER_WHITELIST
CACHE
PERSISTENT_DIR
FETCHCMD
FILE
FILESDIR

(Bitbake rev: 4aa8c2f93cc126778f7e99229d99b398d603fcac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Scott Rifenbark 5f59a85511 bitbake: user-manual-ref-variables.xml: Edits to PREFERRED_PROVIDER.
(Bitbake rev: 9232cca08ec3f099475ad8dfc10e4fa3c2b39366)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Scott Rifenbark 658d885c0c bitbake: user-manual-ref-variables.xml: Added PREFERRED_PROVIDERS to glossary.
(Bitbake rev: 86cacad8129502088011ebb622dd4d3d3663d39e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Scott Rifenbark dac581dbd2 bitbake: user-manual-ref-variables.xml: Added FAKEROOT* variables to glossary.
FAKEROOT
FAKEROOTCMD
FAKEROOTBASEENV
FAKEROOTDIRS
FAKEROOTENV
FAKEROOTNOENV

(Bitbake rev: 8480db0fa7d0363741e7075bb8169a9c1b6a71dd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Scott Rifenbark 606e2cb517 bitbake: user-manual-ref-variables.xml: Added BB* variables to glossary.
BB_STRICT_CHECKSUM
BB_WORKERCONTEXT
BB_SIGNATURE_EXCLUDE_FLAGS
BB_HASHBASE_WHITELIST
BB_INVALIDCONF
BB_LOGFMT
BB_RUNFMT
BB_RUNTASK
BB_HASHBASE_WHITELIST
BB_STAMP_POLICY
BB_STAMP_WHITELIST
BB_SCHEDULER
BB_SCHEDULERS
BB_SETSCENE_DEPVALID
BB_SETSCENE_VERIFY_FUNCTION
BB_SIGNATURE_HANDLER
BB_SRCREV_POLICY
BB_VERBOSE_LOGS

(Bitbake rev: f02be6ca79fccc3c7bfbbadeef0c98242f661524)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:17:05 +00:00
Richard Purdie bfa46b6872 bitbake: user-manual: Fix issue with previous revert
(Bitbake rev: 2d052690d46506ba3f4180ad5cdfa835ce85e59a)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-28 15:29:50 +00:00
Richard Purdie 14778a858e bitbake: Revert "usermanual: Updated CC License to version 3.0"
This reverts commit 0546bc19557de9263b448ceb1707884543d2de56.

This change was not discussed with the copyright holders so the license
needs to remain at version 2.5.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-28 14:29:01 +00:00
Scott Rifenbark 5280192555 bitbake: user-manual-ref-variables.xml: Added 10 new variables to the glossary.
Fixes [YOCTO #5472]

1. ASSUME_PROVIDED
2. BB_CURRENTTASK
3. BB_FETCH_PREMIRRORONLY
4. BB_FILENAME
5. BB_NICE_LEVEL
6. BB_HASHCONFIG_WHITELIST
7. BB_TASK_NICE_LEVEL
8. BB_NO_NETWORK
9. BB_NUMBER_PARSE_THREADS
10. STAMPCLEAN

(Bitbake rev: 72a01a54c4786a7a82ae8b86b8e2beedd07f7f21)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:26 +00:00
Scott Rifenbark 6201d18b79 bitbake: user-manual-ref-variables.xml: Fixed references to "Build Directory".
I made sure that these are lower-cased.  Also, removed the tags
for cross-referencing into the term section of the YP Development
Manual.

(Bitbake rev: f9e3de2bb3e73204ef35d102ff26ee7393056ede)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:26 +00:00
Scott Rifenbark 37ab0888a1 bitbake: user-manual-ref-variables.xml: Editing pass.
Corrected grammar and applied active voice where possible.
Also removed several cross-reference tags to the YP manual set.

(Bitbake rev: 17cbad436c97e904a04596237022e84853b10a21)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:26 +00:00
Scott Rifenbark d51fb535a6 bitbake: template/titlepage.templates.xml: Suppress Title Text.
I commented out two blocks of code that are responsible
for getting the book's title to format onto the title page.
Commenting the code out suppresses the title from the
PDF version's title page yet retains the title text for the
HTML tab space of the browser.  The reason this is necessary
is because the BitBake User Manual uses an image file for
the title.  Thus, it is not necessary to print the title
again.

(Bitbake rev: d7f15880c5423d91fd786e291f3e062545342184)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:25 +00:00
Scott Rifenbark 4fb4928504 bitbake: user-manual-customization.xsl: Updated param list to pass
I added five parameters here to match the build process used
for the YP manual set.

(Bitbake rev: f95994be26986098c2603ef6d4cb10f06422b790)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:25 +00:00
Scott Rifenbark 9dcd60395e bitbake: user-manual-metadata.xml: Renamed section tag
There were two section tags that used the same id name "classes".
One was in the intro chapter and one was in the metadata chapter.
This was causing an exception in the PDF creation process and
breaking it.  I renamed the tag in the metadata chapter
"metadata-classes".

(Bitbake rev: d5f405586f7c50c602241519d32d02b1c7b1f345)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:25 +00:00
Scott Rifenbark e501280162 bitbake: user-manual-ref-variavbles.xml: Added new glossary chapter.
Added a scrubbed copy of the YP ref-manual glossary.  The content
was scrubbed to contain BB variables only.  Removed broken
cross-references, made sure the PDF file built.

(Bitbake rev: aae6bcb7fb6e056eb7b1027a8054f6ea5f8ab2b2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:25 +00:00
Richard Purdie bd4140578e bitbake: user-manual-bitbakecommand: Various edits/cleanups
(Bitbake rev: f079e0886b1b191d84621057f9752cc32bfabb44)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:24 +00:00
Richard Purdie 5cce95c602 bitbake: user-manual-bitbakecommand: Standardise on section tags, not example
(Bitbake rev: c85a035608b7c862d964f45bb1b767fde072a1de)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:24 +00:00
Richard Purdie 2375f55045 bitbake: user-manual-bitbakecommand: Replace screen tags with literallayout
(Bitbake rev: 4fffe48ab607fd0d2f884186006ee168874b8414)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:24 +00:00
Richard Purdie 64f66d7821 bitbake: user-manual-bitbakecommand: Reform whitespace
(Bitbake rev: f1a6d7029e7adc147655809dca71782a143c5ac5)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:24 +00:00
Richard Purdie 32304baea2 bitbake: user-manual-bitbakecommand: Update help text output with that from bitbake master
(Bitbake rev: bd1da5001c03cba17a4c61cfb854ab394c50e732)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:23 +00:00
Richard Purdie 1669f39e47 bitbake: user-manual-fetching: Editing pass over the manual chapter
(Bitbake rev: b0fc79e6405b7070a42cfda035e87edc832f8334)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:23 +00:00
Richard Purdie 123b978c82 bitbake: user-manual-fetching: Change varname/emphasis tags to filename
(Bitbake rev: 3b04c18212f3f0c22a1167dc6f62210e54ed2002)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:23 +00:00
Richard Purdie 0de491b766 bitbake: user-manual-fetching: Change screen -> literallayout
(Bitbake rev: e0474be77c954cac3bb9b403d6c854ff447cc02d)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:23 +00:00
Richard Purdie d0c16f9467 bitbake: user-manual-fetching: Change the file whitespace
(Bitbake rev: 7e32068d1ab4e1f342f70a8338bb8a51fc783da9)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:23 +00:00
Richard Purdie 552d54f2ec bitbake: user-manual-metadata: Clean up task documentation
(Bitbake rev: 55158ce6c5435544a62a60c0055724619bafde27)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:22 +00:00
Richard Purdie ac576f40ac bitbake: user-manual-metadata: Clean up task flag section
(Bitbake rev: b2e8c56d0f554e3b118f23b42858319110501180)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:22 +00:00
Richard Purdie 7b99bc04ac bitbake: user-manual-metadata: Expand parsing process docuemtnation
(Bitbake rev: 2596dd2b42c06ef258032356294cc345a6e25fed)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:22 +00:00
Richard Purdie d6b8f746d4 bitbake: user-manual-metadata: Add section about layers
(Bitbake rev: 0a99fe01dc273c548f7f83f9a7695c21184e7331)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:22 +00:00
Richard Purdie 76072eaa8e bitbake: user-manual-metadata: Add section about INHERIT
(Bitbake rev: f2ffe0365df7aa9c7d6c57b6bff8a5bbed198bfb)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:22 +00:00
Richard Purdie ab18cca2dc bitbake: user-manual-metadata: Add section about running tasks and the environment
(Bitbake rev: b32524643c125c78848630a5ce18d1df36313bc7)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:21 +00:00
Richard Purdie 8705fe2383 bitbake: user-manual-metadata: Rework section about shell/python functions
(Bitbake rev: c2bcb5364ff7c702bc1ec2726169f608b445f979)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:21 +00:00
Richard Purdie 908fdb5cbc bitbake: user-manual-metadata: Add section about data store operations
(Bitbake rev: 85ffd05f292386de1b098debb6a3d3fe18c6b6b7)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:21 +00:00
Richard Purdie c676bf8453 bitbake: user-manual-metadata: Add lists of common events
(Bitbake rev: 240d3f0439e7c1f12e06fa738acc20fbcac8ae65)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:21 +00:00
Richard Purdie c8892fc919 bitbake: user-manual-metadata: Editing pass over the manual chapter
(Bitbake rev: 6f326f2f2785d6d48d7753abee6e8162852d8702)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:20 +00:00
Richard Purdie 98b41e41ff bitbake: user-manual-metadata: Use filename tags instead of literal and varname tags
(Bitbake rev: 56f8c4ad09c244522d68e203fe4cb76d593a9f2f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:20 +00:00
Richard Purdie a0f3328679 bitbake: user-manual-metadata: Replace screen tags with literallayout tags
(Bitbake rev: be3967f9f088e414c679e72a947817b60bab82d7)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:20 +00:00
Richard Purdie 0e90d0f1a4 bitbake: user-manual-metadata: Update whitespace (no content changes)
(Bitbake rev: 7eb1e340321ab4a5baa23e83eebf65ba13d23aef)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:20 +00:00
Richard Purdie 4dd8a0d6d6 bitbake: user-manual-metadata: Reorder sections to more logical order
(Bitbake rev: 6f2bed62bde5cd20f91c336b158f60f4a6bcb82f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:20 +00:00
Richard Purdie 633db4f0ff bitbake: user-manual-metadata: Add section ids for most sections
(Bitbake rev: 4ad94fb161d5fe24869696187e01004bff61d569)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:19 +00:00
Scott Rifenbark 437791a23d bitbake: user-manual-hello.xml: Added new chapter for "Hello World Example"
This file was evidently a "working" file and not included in the
manual at the point Bill left off.  The wmat branch, however, had
a load of commits dedicated to this file.  Rather than attempt to
replay them all one-by-one, I simply copied the file from the
wmat branch and hand-inserted the changes to make it equal to what
was there.  Note also that I re-formatted the file to have the
same formatting standards I use in the YP manuals.

(Bitbake rev: 9ddbf31ba7d05a596ca53b8ed78d94221850894b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:19 +00:00
Scott Rifenbark 1b08402519 bitbake: user-manual.xml: Cleanup on the title page.
1. Added commented out manual revision history.
2. Cleaned up the author stuff.

(Bitbake rev: df92da67ddbb2bcc672911626b9abd1a168cf436)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:19 +00:00
Bill Traynor 3a9593d409 bitbake: user-manual-intro.xml: Re-write of BitBake introduction.
(Bitbake rev: afc998a73f09f3d1a0d7e22425badfa5b7001aa1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:19 +00:00
Richard Purdie a713dade85 bitbake: user-manual-intro: Various minor cleanups/improvements
(Bitbake rev: 5e22c0c5d4bb9e63142a13618f5f87e53c83d9f2)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:19 +00:00
Richard Purdie 5b60a81c95 bitbake: user-manual-intro: Add obtaining bitbake and summary sections
Add new obtaining bitbake and summary sections from Bill Traynor

(Bitbake rev: 083e4e44f52ffdfca68ce6c56eae85ce3b719e1b)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:18 +00:00
Scott Rifenbark e925730cd8 bitbake: user-manual-intro.xml: Added "Concepts" section.
Provided initial text for recipes, configuration files, and
classes.

(Bitbake rev: 55875bcf682979ce538845a8118452425ff96cfc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:18 +00:00
Richard Purdie 2038b85a46 bitbake: user-manual-intro: Update/improve whitespace
(Bitbake rev: fb74a1926c3a603a4c1ebe0325b27fb2c3aec3ee)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:18 +00:00
Richard Purdie 2ee774782c bitbake: user-manual-intro: Expand introduction and fix spelling mistakes
Expand the introduction section, fill out the section ids and fix some spelling
mistakes.

Wording from Bill Traynor/Scott Rifenbark

(Bitbake rev: 780f61da6a59c52555de8574093a264d565b2a75)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:18 +00:00
Bill Traynor 7c98419b09 bitbake: documentation: Add README based off the YP docs one
Reusing the README file from the Yocto Project Documentation
directory but removed the YP specific content and changed to be
specific to BitBake.

(Bitbake rev: 67b6e9c54676e979c546c0d350b2d01443f13f36)

Signed-off-by: Bill Traynor <wmat@alphatroop.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:03:17 +00:00
Richard Purdie bfa18b58d3 bitbake: user-manual: Separate out chapters into individual files
Splitting the manual into a chapter per file makes the content
a little more managable.

(Bitbake rev: 020178eba958d2d5142ee0909fc0fd133b97cd92)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:01:08 +00:00
Bill Traynor 034e49004f bitbake: user-manual: Import YP Docs templates for usermanual improvements
Import the necessary pieces to be able to build the BitBake User
Manual using make in a similar way that the Yocto Documentation is
built.  The Makefile has been edited to remove Yocto Project specific
content and adapt for bitbake's needs.

(Bitbake rev: d4199078692f86341ed5b42a7c2dd4b34819aead)

Signed-off-by: Bill Traynor <wmat@alphatroop.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:01:08 +00:00
Bill Traynor eeb4c71647 bitbake: usermanual: Renamed manual dir to user-manual to be consistent.
Renaming the manual directory to user-manual in order to allow
for future additions of specific manual types, such as a
dev-manual.

(Bitbake rev: 4617aa5e8491067f7825062ed3baee27cf697e88)

Signed-off-by: Bill Traynor <wmat@alphatroop.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:01:08 +00:00
Bill Traynor afac3d83bd bitbake: usermanual: Updated CC License to version 3.0
Updated the Creative Commons License to the most current version,
version 3.0.  Also updated the Creative Commons mailing address.

(Bitbake rev: 0546bc19557de9263b448ceb1707884543d2de56)

Signed-off-by: Bill Traynor <wmat@alphatroop.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-27 21:01:07 +00:00
Robert Yang 4722965f82 bitbake: bitbake: usermanual.xml: fix a typo
Fixed:
"should created" -> "should be created"

[YOCTO #5703]

(Bitbake rev: 146318729dbeeee4136bcb4832e6f8f69f9a2489)

Signed-off-by: Robert Yang <liezhi.yang@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-07 13:42:55 +00:00
Scott Rifenbark 825cfeb2e6 bitbake: usermanual.xml: Two new sections added to BitBake "Description"
1. Added a new section "Appending and Prepending (override style
   syntax)".  This section shows how the append and prepend operators
   work using the override style syntax.

2. Added a new section "Removing (override style syntax)".  This
   section describes the new "_remove" operator.

(Bitbake rev: 6983afab0ce8d82d102142636d5a570f7d86a844)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-17 22:27:56 +01:00
Richard Purdie 8054716544 bitbake: doc/bitbake.1: Update with missing parameters
Patch from Nobuhiro Iwamatsu <nobuhiro.iwamatsu.yj@renesas.com> to
add missing parameters to bitbake man page. Added hob to ui list too.

[YCOTO #4049]

(Bitbake rev: ca7cd6c1318e0ef066f9e12e7516a47b2af3a7d1)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-25 15:58:31 +00:00
Robert P. J. Day 5051e9837f bitbake: usermanual: Fix missing markup
(Bitbake rev: 68af2b09315ba35eae24933a599014a662789c2c)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06 09:41:56 +01:00
Richard Purdie 852266d0bc bitbake: usermanual: Improve task dependency documentation to match reality
(Bitbake rev: f67c0606fc681359fb0c68be55cfc9f11d410f17)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04 14:48:15 +01:00
Enrico Scholz 358016f463 bitbake: support $BITBAKE_UI environment
Patch adds support for a $BITBAKE_UI environment variable which allows
to configure the preferred user interface. Although an '-u' option
(which will override the environment variable) exists already, it was
required to specify this option on every invocation of bitbake.

Because user interface is instanciated very early in the program it is
not possible to use bitbake.conf for setting up a default.  An
environment variable (which acts in a similar category like $PAGER or
$EDITOR) is a simple way for configuring the default.

(Bitbake rev: e3c213015953d1a0afb5ef4be59e1264990e5cee)

Signed-off-by: Enrico Scholz <enrico.scholz@sigma-chemnitz.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-23 11:35:11 +01:00
Robert P. J. Day 98291b5ed2 Fix typo in user manual: "incarantion" -> "incarnation"
(Bitbake rev: dd15a92a0932d3e177c0ca7b2923da1d72046e51)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-06 01:12:42 +01:00
Darren Hart 11cce80137 usermanual: Correct "inherit" search to bbclass from oeclass
Bitbake looks for bbclass now, not oeclass. Update the docs accordingly.

(Bitbake rev: 8b713708541f85a4252c0f7b683aff4407c7d3e0)

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-20 16:47:38 +00:00
Richard Purdie 4cd9671078 bitbake: Update users of getVar/setVar to use the data store functions directly
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-27 10:35:30 +00:00