28 Commits

Author SHA1 Message Date
Scott Rifenbark
8615d47a3a bitbake: bitbake-user-manual: Created unique tags for glossary variables.
Fixes [YOCTO #12399]

The bug was to get the BitBake User Manual into the YP Mega-manual.
All the changes here create unique tags used with variables in the
BitBake Manual.  Prior to the fix, tags were identical between like
variables in the YP reference manual and the BitBake User Manual.
The reason for this is because when I created the BitBake manual's
glossary, it was a cut-and-paste operation to get the bulk of
the work started.  At the time, the BitBake User Manual was not
a part of the Mega-manual.  Once we decided to include the
BitBake User Manual as part of the Mega-Manual, building the
mega-manual produced warnings for all these duplicate links.

To fix, I have updated the variable tags in the BitBake User
Manual to use the following form:

   'var-bb-<variable_name>'

The tags used in the YP ref-manual follow this form (original):

   'var-<variable_name>'

(Bitbake rev: fb6de2057aae3fbdf37f007d2e47794b332020e1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 13:08:30 +00:00
Scott Rifenbark
8c0a94129e bitbake: bitbake-user-manual: Added wildcarding descriptions
Fixes [YOCTO #12390]

Added specific descriptions for how wildcarding works for a variety
of variables and files (e.g. append files).

(Bitbake rev: 0a4377cb1837ede213d9640344f4908de3689d91)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29 16:54:48 +00:00
Scott Rifenbark
6e9ff843fd bitbake: bitbake-user-manual: Added section on multicong dependencies
Created a new section to show how to handle dependencies when
you are doing a multiple configuration build.  Put it in the
"Examples" section.

(Bitbake rev: fa42212a6cb7b64add4d6ca0f723a95c908c6b87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:31 +01:00
Scott Rifenbark
859d36b130 bitbake: bitbake-user-manual: Added BBMULTICONFIG support
The BBMULTICONFIG variable is a variable used for BitBake and was
not documented in the BitBake Manual glossary.  I added the
definition.  I also added the variable to the example in the section
describing how to execute builds for multiple configurations.

(Bitbake rev: 836f994ec530ba82c935cb41e006d1f128885dc2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:31 +01:00
Scott Rifenbark
e06421bfc4 bitbake: bitbake-user-manual: Added new section on multiconfig builds
Created a new example.  Also added a figure for the separate
configuration file hierarchy

(Bitbake rev: f2d432674b187685591f60cec3b2980b377c63fe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:31 +01:00
Kristi Rifenbark
e5946b39c1 bitbake: bitbake-user-manual: Updated BitBake help output due to runall command-line options.
Fixed [YOCTO #12547]

(Bitbake rev: 80de8c2369da5856b68458774ea63730063fcfa3)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-20 17:51:10 +00:00
Scott Rifenbark
7e51c4b299 bitbake: bitbake-user-manual: Updated 'bitbake -h' output example.
(Bitbake rev: 3e2a6f2a820482c360b66af777d9a38734b56c92)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-01-16 20:34:02 +00:00
Leonardo Sandoval
0582b2c6ca bitbake: bitbake-user-manual/bitbake-user-manual: remove YP as build system
YP is not a build system, so it can not be used as build system example.

(Bitbake rev: dc86d38816aeb0fcbceb34cbaaa6ed98d33383e9)

Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-07 23:20:41 +01:00
Scott Rifenbark
eff56e4f0d bitbake: bitbake-user-manual: Fixed special character in -D output
Fixes [YOCTO #9962]

The new output for -D was copied into the manual and merged by
the engineering team before checking to see if the manual
would make properly.  The next output for -D introduced an
error through the string "<task>".  The angled bracket
characters are illegal in docbook and must be replaced by
"&lt;" and "&gt;", respectively.  I made this fix.

(Bitbake rev: 0476ec4605c94b9e0208cfd3fa48ecf3e3f04181)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-03 22:32:02 +01:00
Diana Thayer
71e48a3617 bitbake: main: Improve -v and -D option documentation
Expanded and clarify documentation for the -v, --verbose and -D, --debug
options.

[YOCTO #9962]

(Bitbake rev: 921592026c69287cdb40ffd90944d5944f28e2c3)

Signed-off-by: Diana Thayer <garbados@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-27 20:23:19 +01:00
Scott Rifenbark
bcfb0da4fe bitbake: bitbake-user-manual: Rewrite dependency dot file generation
The package-depends.dot and pn-depends.dot files are inaccurate,
missing out key dependencies such those made via the [depends]
flags. As such they can be misleading to the user.

They mainly exist for historical reasons, coming from a time
before we had task based execution.

This commit removes the two dated file formats and replaces
them with a recipe-depends.dot which is a flattened version
of task-depends.dot.

The old format files are removed if present so that the user
can't get confused about why data might not match between files.

The code is also rewritten to use 'with f: f.write()' syntax as
is more commonly used now. Also update the docs to match the change.

(Bitbake rev: f82537d27f2a5bf9d576aa841593db9ec0985ea8)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01 15:46:59 +00:00
Richard Purdie
6cfc1c83b9 bitbake: cooker: Rewrite dependency dot file generation
The package-depends.dot and pn-depends.dot files are inaccurate, missing
out key dependencies such those made via the [depends] flags. As such
they can be misleading to the user.

They mainly exist for historical reasons, coming from a time before
we had task based execution.

This commit removes the two dated file formats and replaces them with
a recipe-depends.dot which is a flattened version of task-depends.dot.

The old format files are removed if present so that the user can't get
confused about why data might not match between files.

The code is also rewritten to use 'with f: f.write()' syntax as is more
commonly used now.

Also update the docs to match the change.

(Bitbake rev: d3e182bc18ff2894f1efc8aad3d508dd432c996e)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19 06:28:46 -08:00
Richard Purdie
701ae7d1f4 bitbake: doc: Replace depexp UI with taskexp and cleanup UI lists
The depexp UI has been replaced with taskexp, also remove old
references to goggle and hob.

(Bitbake rev: 814c2b232ea5f88b5ad5031fb9d389c9c594aa01)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19 06:28:46 -08:00
Scott Rifenbark
9403e82f67 bitbake: bitbake-user-manual: Refreshed the 'bitbake --help' output.
(Bitbake rev: d7121d919beaa4be2c18d8f0bbd4afe01590eb7b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08 16:36:02 +00:00
Scott Rifenbark
ae427fb097 bitbake: bitbake-user-manual: Changed bitbake command example.
Fixes [YOCTO #7718]

In the "Executing a List of Task and Recipe Combinations"
section, I changed the improper bitbake command example to
use the correct syntax.  This change was review feedback.

(Bitbake rev: c79fab1be4898ec88bfddd4c4f84e76dc3a3125b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:22:15 +01:00
Richard Purdie
2652217970 bitbake: Revert "bitbake-user-manual: Added new section on command-line execution"
This reverts commit 6f6cd0674fd1595f4e74b7da692e0c348b2660c6 as it was
a duplicated commit.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02 15:21:46 +01:00
Scott Rifenbark
380b6e80ce bitbake: bitbake-user-manual: Added new section on command-line execution
Needed a section on executing a list of task and recipe combinations.

(Bitbake rev: 6f6cd0674fd1595f4e74b7da692e0c348b2660c6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:54 +01:00
Scott Rifenbark
8321d66696 bitbake: bitbake-user-manual: Added new section on command-line execution
Needed a section on executing a list of task and recipe combinations.

(Bitbake rev: 17f7f366df3a5951ae88e24c43aecf3d65d83c14)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21 07:47:53 +01:00
Scott Rifenbark
0262bc51cd bitbake: bitbake-user-manual: Updated the 'bitbake -h' output example.
(Bitbake rev: 4ca651d32d9e5fbf7f932b4167804905969f4c3a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18 16:20:50 +01:00
Scott Rifenbark
d0dec8496f bitbake: bitbake-user-manual/bitbake-user-manual-intro.xml: Fixed link
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-02 09:30:01 +01:00
Robert P. J. Day
653b557770 bitbake: "per-package" should say "per-recipe"
(Bitbake rev: 1cd369883469747a8158826bb8d67dcca2a8577f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Scott Rifenbark
8b7116d25e bitbake: Updated the the example 'bitbake -h' output to match the actual 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-22 08:33:25 +01:00
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 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
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
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