1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00
Files
poky/bitbake/doc
Scott Rifenbark bcfb0da4fe bitbake: bitbake-user-manual: 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: f82537d27f2a5bf9d576aa841593db9ec0985ea8)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01 15:46:59 +00:00
..
2007-01-08 23:53:01 +00:00
2005-08-31 10:47:56 +00: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.