citadel/bitbake/doc
brl 098b8f982b Squashed 'poky/' content from commit 4469acdf1d
git-subtree-dir: poky
git-subtree-split: 4469acdf1d0338220f3fe2ecb5e079eea6fda375
2017-12-04 16:35:29 -05:00
..
bitbake-user-manual Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
template Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
tools Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
bitbake.1 Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
COPYING.GPL Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
COPYING.MIT Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
Makefile Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
poky.ent Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05:00
README Squashed 'poky/' content from commit 4469acdf1d 2017-12-04 16:35:29 -05: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.