mirror of
https://git.yoctoproject.org/git/poky
synced 2026-01-01 13:58:04 +00:00
392de9d568
This manual gets combined with other manuals and in that context, it helps a lot if its seen as the Bitbake User Manual. Renames are a pain but this is worthwhile so that other docs can correctly be combined with this one. This also clarifies things like google search results which is helpful. (Bitbake rev: 452a62ae0c2793e281d6769fd3e45500a74898d6) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
40 lines
1.1 KiB
Plaintext
40 lines
1.1 KiB
Plaintext
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.
|