Files
poky/bitbake/doc
Scott Rifenbark c5095104aa bitbake: user-manual: Review edits from Richard (second draft)
Applied the comprehensive set of review comments from Richard
Purdie.  All files affected.  One major point here was that the
"BitBake Command" chapter was eliminated.  This information was
folded into various areas of the book.  Consequently, the bits
including the file for make had to be updated.

(Bitbake rev: 8ec38c6b456a92a0e0b9b04c2793a5b148be5027)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09 18:59:04 -07: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:

  • 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=user-manual

template

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

tools

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