mirror of
git://git.yoctoproject.org/poky
synced 2026-10-02 17:03:55 +00:00
eb169fe8b3
I think having a couple real-life examples here would make a huge difference. Comment from Scott: I modified the example description to indicate that it is from an OpenEmbedded metadata-based recipe (i.e from YP). We have been trying very hard to keep the BitBake User Manual as separate as possible from the YP docs. (Bitbake rev: 834780772a08ecce7ed863e96d0674b47d0e589d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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.