Commit Graph

30 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
2520246d67 bitbake: bitbake-user-manual: Updates to variable wildcard support.
Fixes [YOCTO #12390]

Applied some fixes to the variable wildcard support documentation
in the BitBake manual.  Wording changes and changes to make links
referencing Python syntax go to version 3 rather than version 2.

(Bitbake rev: 0cfc71d1a342b82781b0ba547421e41f6340902a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29 16:54:48 +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
Chris Laplante via bitbake-devel
76361c9b38 bitbake: bitbake-user-manual: fix description of BB_RUNTASK
Contrary to what the manual said, BB_RUNTASK does include the do_
prefix, unlike BB_CURRENTTASK.

(Bitbake rev: 3f4968c77129252e8d0833fbd683372fca243a90)

Signed-off-by: Chris Laplante <chris.laplante@agilent.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-18 10:59:27 +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
adde339596 bitbake: bitbake-user-manual: Updated "OpenEmbedded-Core" term.
Made sure that the terms "OpenEmbedded-Core" and "OE-Core"
are used as such throughout the manual.

(Bitbake rev: 677e58f8616a4bf58772e54d2313af3885a3b110)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-04-12 22:25:17 +01:00
Nicolas Cornu
f16d8be9ab bitbake: bitbake-user-manual: Added google-repo fetcher and REPODIR var.
Added a new repo Fetcher section in the same spirit as the existing
sections for other supported fetchers.  Changes included the new section,
removal of the bulleted item that mentioned this fetcher as an
"additional" fetcher, and the creation of a new variable in the glossary
named REPODIR.

(Bitbake rev: 1cf084cee506574b7bb6ed03344597b3b2f2fe08)

Signed-off-by: Nicolas Cornu <nicolac76@yahoo.fr>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:26:03 +00:00
Scott Rifenbark
3927067c8e bitbake: bitbake-user-manual: Updated kernel version in PREFERRED_VERSION example
(Bitbake rev: 41ba3c8bfcd3501604f6a17bd327a8193b11b656)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 15:44:15 +01:00
Scott Rifenbark
2bf2ab9fcd bitbake: bitbake-user-manual: Updated BBLAYERS_FETCH_DIR variable description
Just discovered a minor issue in the bitbake manual - under the variable
glossary entry for BBLAYERS_FETCH_DIR we say there's a default value of
${COREBASE} but that's not actually true in bitbake itself - there's no
default in bitbake, that default is set in OE-Core. We can keep this in the YP
ref manual but in the bitbake manual that sentence should be removed.

(Bitbake rev: 7b4e81772ed8789521661a3b32b576c91276ae34)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-15 11:15:59 +01:00
Scott Rifenbark
31ec7fa01d bitbake: bitbake-user-manual: Updated INHERIT descriptions
Fixes [YOCTO #11498]

Enhanced the glossary description for the INHERIT variable to give more
detail and to cross-reference the reader back into the Chapter 3
section describing its use.

(Bitbake rev: 362f6044fcaafe51ab4377af8f2606165b112717)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-23 17:45:37 +01:00
Richard Purdie
2334036502 bitbake: fetch/local: Drop FILESDIR
This has long since been deprecated and is no longer used anywhere, FILESPATH
is the commonly used varaible which offers much more flexibility. Remove
the FILESDIR code and references from bitbake.

(Bitbake rev: 751c9dc51fd01fa64a1ff37ba2638110335f71af)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-05 23:20:03 +01:00
Scott Rifenbark
1a95d4a070 bitbake: bitbake-user-manual: Changed BB_SETSCENE_VERIFY_FUNCTION name
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed
to BB_SETSCENE_VERIFY_FUNCTION2.  I changed the three areas in the
book.  Basically a name change.

(Bitbake rev: 41d9cd41d40b04746c82b4a940dca47df02514fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13 23:29:25 +01:00
Scott Rifenbark
e205789361 bitbake: bitbake-user-manual: Updated the PROVIDES variable
Fixes [YOCTO #10011]

Added paragraphs near the end to describe the role of virtual
targets.

(Bitbake rev: fc47bb99dbc1972dfb3a83c0f4c479963da64bcc)

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
Scott Rifenbark
80b1efb62c bitbake: bitbake-user-manual: Fixed typo in the BBDEBUG variable description.
In the BBDEBUG variable description, the "-d" parameter needed to
be "-D".  Fixed it.

Fixes [YOCTO #9950]

(Bitbake rev: 475e7611f6c5b884d86152cb0b334e9d96849608)

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
9a9577ed49 bitbake: bitbake-user-manual: Added review changes to BBCLASSEXTEND description
Fixes [YOCTO #9909]

Added some technical clarifications to the existing note to be clear
about what is causing the limitations in this case.  Applied some
formatting fixed to for the use of the include word.

(Bitbake rev: e9ad2e0f6d2681dd793cc39c468eb86e57fd6f48)

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
Andrew Bradford
35081f5518 bitbake: bitbake-user-manual: Addeds support for the Perforce Fetcher
Added a new Perforce Fetcher section in the same spirit as the existing
sections for other supported fetchers.  Changes included the new section,
removal of the bulleted item that mentioned this fetcher as an
"additional" fetcher, and the creation of a new variable in the glossary
named P4DIR.

(Bitbake rev: 47e03b1789ee1c18407dbac33a6c235752019865)

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
a6cffcffc1 bitbake: bitbake-user-manual: Added clarifying note to BBCLASSEXTEND variable.
Fixes [YOCTO #9909]

Added a note that talks about how the BBCLASSEXTEND mechanism
adds recipe variants.

(Bitbake rev: 185c9c5fc205fe9c9daf5238f11b92bd0954f5c6)

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
Christopher Larson
32ee30a46d bitbake: Provide LAYERDIR_RE for layer.conf
This variable is a regex-escaped version of LAYERDIR, for safer use in
BBFILE_PATTERN, so as to avoid issues with regex special characters in the
layer path.

[YOCTO #8402]

(Bitbake rev: 72900522778b6ff08b135bf8bb97dff3f1a20bd9)

Signed-off-by: Christopher Larson <chris_larson@mentor.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-05-19 09:05:21 +01:00
Peter Kjellerstedt
d61d290ad7 bitbake: bitbake-user-manual-ref-variables: Update the help for BBMASK
Update the help for BBMASK to reflect that it is now allowed to
contain multiple regular expressions. Also changed the examples for
BBMASK to be a bit more diverse.

(Bitbake rev: 023a5b69df05adce0ed192b393b45eb879c096a0)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29 17:03:53 +00:00
Scott Rifenbark
c8051c52a4 bitbake: bitbake-user-manual: Added new description for BB_TASK_IONICE_LEVEL
Added a new variable description here for this variable.

(Bitbake rev: 4e0da1ef4a58a7ba4b92d4e07ef79cf7bd90abf0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29 07:35:51 +00:00
Scott Rifenbark
183290a9d4 bitbake: bitbake-user-manual: Added BBTARGETS variable description.
(Bitbake rev: 0f0c205b9d6c24bee334eabb359973e0368ce931)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29 07:35:51 +00:00
Trevor Woerner
a06a5ae684 bitbake: bitbake-user-manual-ref-variables: Added BBLAYERS_FETCH_DIR glossary item.
Add BBLAYERS_FETCH_DIR to the Variables Glossary.

(Bitbake rev: 5ecd6a671c088f270d5f49093f8da83278fc0aa9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-23 11:47:40 +01:00
Scott Rifenbark
7a98387e29 bitbake: bitbake-user-manual-ref-variables.xml: Added BB_ALLOWED_NETWORKS desc.
Added a new variable description for the BB_ALLOWED_NETWORKS
variable.

(Bitbake rev: 1408654e6d8f5ae962744c6cc2d8a49df34c5101)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-16 23:58:16 +01:00
Scott Rifenbark
203aaaec08 bitbake: bitbake-user-manual: Cleaned up parallelism note and formatted user input
I updated the note in the second chapter that discusses the role for
BB_NUMBER_THREADS.  The updates make it a bit clearer.

Also scrubbed the manual for instances of user-supplied values to check
how they are being formatted.  I fixed the formatting to use the
<replaceable></replaceable> tags so they are in italics.

(Bitbake rev: e2879c60e905d7566091d40eab330372fa001313)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-17 13:28:47 +01:00
Scott Rifenbark
d87805b66d bitbake: bitbake-user-manual: Added five new repo variables and links.
Added the following variables to the glossary:

  CVSDIR
  GITDIR
  SVNDIR
  HGDIR
  BZRDIR

Several areas in the main manual mentioned these variables.  For
each, I added the appropriate link to the glossary term.

(Bitbake rev: 5b797c758bf0499646e4e0256f03fbbdfb3ea080)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10 23:09:32 +00: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
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
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
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