Commit Graph

57 Commits

Author SHA1 Message Date
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 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