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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Add new obtaining bitbake and summary sections from Bill Traynor
(Bitbake rev: 083e4e44f52ffdfca68ce6c56eae85ce3b719e1b)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
(Bitbake rev: dd15a92a0932d3e177c0ca7b2923da1d72046e51)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Document the ability to use SRC_URI parameters for checksums
(Bitbake rev: 0a6443f9e1d07865c9fd1dfc0b4622eb1c4c3f3a)
Signed-off-by: Joshua Lock <josh@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This patch contains what I hope are non-controversial improvements to
the manual. Most of the changes are single characters, but the
line-by-line diff makes the patch look large.
(Bitbake rev: 5481cc90645e13c4e3cdea41e8e369528a0b1649)
Signed-off-by: Brandon Stafford <brandon@pingswept.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
At best it gave 1-2% improvement now, its 32 bit x86 only and isn't
supported after python 2.6.
PyPy is probably a better option now.
(Bitbake rev: 3c3bd0c2fa80d747f25401c17b785c7c2f3787ca)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"is used signify" -> "is used to signify"
(Bitbake rev: c3dd4fd5c9fe106f7fae8c088e75cfb70f20e107)
Signed-off-by: Bernhard Reutner-Fischer <rep.dot.nop@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix [BUGID #593]
The current manual build fails for printing formats which use latex as an
intermediate format. This bug has been reported in multiple locations and I
haven't found a solution posted to any of them.
Using --with-dblatex uses dblatex to make the conversion and successfully
generates the pdf. It adds a dependency on dblatex and its dependencies.
Signed-off-by: Darren Hart <dvhart@linux.intel.com>
CC: Joshua Lock <josh@linux.intel.com>
(Bitbake rev: f42e6d33b986183eee2c74aa7b1bbc9b339276a9)
Signed-off-by: Andreas Oberritter <obi@opendreambox.org>
Signed-off-by: Chris Larson <chris_larson@mentor.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
to make python3 happy
(Bitbake rev: c82926ccdd4ec4e3ad6e78a381dacb96adf9b409)
Signed-off-by: Bernhard Reutner-Fischer <rep.dot.nop@gmail.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
"DL_DIRS" -> "DL_DIR"
Remove superfluous trailing ">" after CVSDIR.
(Bitbake rev: 34f396e749303367e657911bf10c43086dff7552)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Chris Larson <chris_larson@mentor.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
This implements a feature similar to BBCLASSEXTEND, but for generating
multiple versions of a given recipe. For example: BBVERSIONS = "1.0 2.0 git".
In addition to the above, one can utilize [a-b] style patterns, and can have a
:<basever> postfix, which allows you to essentially name the range of
versions. Both the current version and the basever end up in OVERRIDES, and
the basever gets placed into the BPV variable. The default BPV, if none is
specified, is the original PV of the recipe, before bbversions processing.
In this way, you can do things like:
BBVERSIONS = "1.0.[0-6]:1.0.0+
1.0.[7-9]:1.0.7+"
SRC_URI_append_1.0.7+ = "file://some_extra_patch.patch;patch=1"
Or you can create a recipe per range, and name the recipe file as such: nano_1.0.7+.bb.
(Bitbake rev: 4ee9a56e16f1eb3c1649eaa3127b09ab0e93d1ec)
Signed-off-by: Chris Larson <chris_larson@mentor.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
??= is a lazy, conditional assignment. Whereas a ?= immediately assigns to
the variable if the variable has not yet been set, ??= does not apply the
default assignment until the end of the parse. As a result, the final ??= for
a given variable is used, as opposed to the first as in ?=.
Note that the initial implementation relies upon finalise() to apply the
defaults, so a "bitbake -e" without specifying a recipe will not show the
defaults as set by ??=. Moving application of the default into getVar adds
too large a performance hit. We may want to revisit this later.
(Bitbake rev: 74f50fbca194c9c72bd2a540f4b9de458cb08e2d)
Signed-off-by: Chris Larson <chris_larson@mentor.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* File licence headers were sanitised causing most of the diff.
* cooker.py was created from bin/bitbake.
* cvs fetcher port option was added
* The -f force option was fixed to work correctly
* Multiple entries in rrecrdeps are now handled correctly
(allows adding do_deploy to image depends)
git-svn-id: https://svn.o-hand.com/repos/poky/trunk@1129 311d38ba-8fff-0310-9ca6-ca027cbcb966