Files
poky/bitbake/doc
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
..
2007-01-08 23:53:01 +00:00
2005-08-31 10:47:56 +00:00

Documentation

This is the directory that contains the BitBake documentation.

Manual Organization

Folders exist for individual manuals as follows:

  • bitbake-user-manual - The BitBake User Manual

Each folder is self-contained regarding content and figures.

If you want to find HTML versions of the BitBake manuals on the web, go to http://www.openembedded.org/wiki/Documentation.

Makefile

The Makefile processes manual directories to create HTML, PDF, tarballs, etc. Details on how the Makefile work are documented inside the Makefile. See that file for more information.

To build a manual, you run the make command and pass it the name of the folder containing the manual's contents. For example, the following command run from the documentation directory creates an HTML and a PDF version of the BitBake User Manual. The DOC variable specifies the manual you are making:

 $ make DOC=bitbake-user-manual

template

Contains various templates, fonts, and some old PNG files.

tools

Contains a tool to convert the DocBook files to PDF format.