sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity
generic-poky/bitbake/doc
History
Scott Rifenbark 790cc61a75 bitbake: user-manual-execution.xml: Added how BB processes curly braces. 
(Bitbake rev: f4ebc4de63d64e3b5f87e1d0f51507760c3d82d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
 		2014-03-30 10:19:49 +01:00
..
template bitbake: template/titlepage.templates.xml: Suppress Title Text. 2014-01-27 21:03:25 +00:00
tools bitbake: user-manual: Import YP Docs templates for usermanual improvements 2014-01-27 21:01:08 +00:00
user-manual bitbake: user-manual-execution.xml: Added how BB processes curly braces. 2014-03-30 10:19:49 +01:00
COPYING.GPL bitbake: Sync with upstream. 2007-01-08 23:53:01 +00:00
COPYING.MIT Initial population 2005-08-31 10:47:56 +00:00
Makefile bitbake: Makefile: Added publish tag so the book can be published. 2014-03-25 13:23:05 +00:00
README bitbake: documentation: Add README based off the YP docs one 2014-01-27 21:03:17 +00:00
bitbake.1 bitbake: doc/bitbake.1: Update with missing parameters 2013-03-25 15:58:31 +00:00
poky.ent bitbake: user-manual: Import YP Docs templates for usermanual improvements 2014-01-27 21:01:08 +00:00

README 

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.