1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-10 05:49:28 +00:00
Files
poky/bitbake/doc
Joshua Watt 03e35419af bitbake: bitbake-user-manual: Add documentation for BB_LOGCONFIG
Adds documentation describing how to use the BB_LOGCONFIG variable to
enable custom logging.

(Bitbake rev: e22565968828c86983162e67f52ebb106242ca76)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-13 11:29:23 +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.