mirror of
https://git.yoctoproject.org/poky
synced 2026-06-18 06:39:53 +00:00
Scott Rifenbark
437791a23d
This file was evidently a "working" file and not included in the manual at the point Bill left off. The wmat branch, however, had a load of commits dedicated to this file. Rather than attempt to replay them all one-by-one, I simply copied the file from the wmat branch and hand-inserted the changes to make it equal to what was there. Note also that I re-formatted the file to have the same formatting standards I use in the YP manuals. (Bitbake rev: 9ddbf31ba7d05a596ca53b8ed78d94221850894b) 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:
* 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.