1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00
Files
poky/bitbake/doc
Scott Rifenbark 4283ae56a9 bitbake: bitbake-user-manual: Updated inherit and INHERIT sections
Fixes [YOCTO #12031]

Moved an inappropriate example from the bottom of the INHERIT
Configuration Directive section up into the inherit directive
section.

Updated the example at the end of the INHERIT Configuration
Directive section to apply to INHERIT.

(Bitbake rev: f169ac5da18d55a40d0554668e1a0ace70f94768)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 17:19:15 +01: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.