generic-poky

History

Richard Purdie 6cfc1c83b9 bitbake: cooker: Rewrite dependency dot file generation The package-depends.dot and pn-depends.dot files are inaccurate, missing out key dependencies such those made via the [depends] flags. As such they can be misleading to the user. They mainly exist for historical reasons, coming from a time before we had task based execution. This commit removes the two dated file formats and replaces them with a recipe-depends.dot which is a flattened version of task-depends.dot. The old format files are removed if present so that the user can't get confused about why data might not match between files. The code is also rewritten to use 'with f: f.write()' syntax as is more commonly used now. Also update the docs to match the change. (Bitbake rev: d3e182bc18ff2894f1efc8aad3d508dd432c996e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>		2017-02-19 06:28:46 -08:00
..
bitbake-user-manual	bitbake: cooker: Rewrite dependency dot file generation	2017-02-19 06:28:46 -08: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: doc: Replace depexp UI with taskexp and cleanup UI lists	2017-02-19 06:28:46 -08: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.