generic-poky

History

Richard Purdie 69b6919341 bitbake: bitbake: Add explict getVar param for (non) expansion Rather than just use d.getVar(X), use the more explict d.getVar(X, False) since at some point in the future, having the default of expansion would be nice. This is the first step towards that. This patch was mostly made using the command: sed -e 's:\(getVar([^,()]\)\s):\1, False):g' -i `grep -ril getVar *` (Bitbake rev: 659ef95c9b8aced3c4ded81c48bcc0fbde4d429f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>		2015-06-23 11:57:53 +01:00
..
bitbake-user-manual	bitbake: bitbake: Add explict getVar param for (non) expansion	2015-06-23 11:57:53 +01:00
template	bitbake: templates: Added newline character to end of script.	2014-07-03 13:58:57 +01:00
tools	bitbake: user-manual: Import YP Docs templates for usermanual improvements	2014-01-27 21:01:08 +00: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: Updated the script to not create PDF version by default	2015-02-10 23:09:32 +00:00
README	bitbake: doc: Rename user-manual -> bitbake-user-manual	2014-04-21 23:03:18 +01:00
bitbake.1	bitbake: "per-package" should say "per-recipe"	2014-07-23 10:02:13 +01: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:

* 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.