CaROS/poky
3
1
Fork 0
mirror of https://git.yoctoproject.org/git/poky synced 2026-01-04 16:10:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
eff56e4f0d
poky/bitbake/doc
History
Scott Rifenbark eff56e4f0d bitbake: bitbake-user-manual: Fixed special character in -D output 
Fixes [YOCTO #9962]

The new output for -D was copied into the manual and merged by
the engineering team before checking to see if the manual
would make properly.  The next output for -D introduced an
error through the string "<task>".  The angled bracket
characters are illegal in docbook and must be replaced by
"&lt;" and "&gt;", respectively.  I made this fix.

(Bitbake rev: 0476ec4605c94b9e0208cfd3fa48ecf3e3f04181)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-03 22:32:02 +01:00
..
bitbake-user-manual bitbake: bitbake-user-manual: Fixed special character in -D output 2017-04-03 22:32:02 +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
bitbake.1 bitbake: doc: Replace depexp UI with taskexp and cleanup UI lists 2017-02-19 06:28:46 -08:00
COPYING.GPL
COPYING.MIT
Makefile bitbake: Makefile: Updated the script to not create PDF version by default 2015-02-10 23:09:32 +00:00
poky.ent bitbake: user-manual: Import YP Docs templates for usermanual improvements 2014-01-27 21:01:08 +00:00
README bitbake: doc: Rename user-manual -> bitbake-user-manual 2014-04-21 23:03:18 +01: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.