sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity
generic-poky/documentation
History
Scott Rifenbark b257acf053 documentation/dev-manual/dev-manual-start.xml: Wording change 
Added a bit more information to the wording where it talks about
creating a Git Repository if you are going to contribute back
into YP.  This change was suggested by Robert P. J. Day and
was submitted to me in the form of a patch.  For reasons unknown
to me the patch Hunk failed even though I believe I had things
saved and applied correctly.  I had to resort to applying it by
hand.  I ended up doing a bit of re-writing on the suggested
change to clean it up.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 94f90c91e6b1d13bebc7a434210452f222ef0317)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
 		2012-03-08 12:08:07 -08:00
..
adt-manual documentation: Edits to all style.css files 2012-03-08 12:08:03 -08:00
bsp-guide documentation: Section change and cross-reference fixes 2012-03-08 12:08:06 -08:00
dev-manual documentation/dev-manual/dev-manual-start.xml: Wording change 2012-03-08 12:08:07 -08:00
kernel-manual documentation: Edits to all style.css files 2012-03-08 12:08:03 -08:00
poky-ref-manual documentation/poky-ref-manual/ref-variables.xml: New glossary entries 2012-03-08 12:08:06 -08:00
template documentation/pokt-ref-manual: Update with Yocto branding 2010-10-27 07:50:33 +01:00
tools documentation/tools: Add comments to script 2010-10-15 15:07:05 +01:00
yocto-project-qs documentation/yocto-project-qs/yocto-project-qs.xml: Title fixed 2012-03-08 12:08:05 -08:00
Makefile documentation/Makefile: new 'edison' variable for YP dev manual. 2012-03-08 12:07:44 -08:00
README documentation/README: Created a README file 2012-03-08 12:08:05 -08:00
poky.ent documentation: Variables for docs and QS variablized 2012-03-08 12:07:36 -08:00

README 

documentation
=============

This is the location for the Yocto Project documentation.  Documentation 
consists of six manuals (see below).

Manual Organization
===================

Folders exist for individual manuals as follows:

* adt-manual       - The Yocto Project Application Development Toolkit (ADT)
                     User's Guide.
* bsp-guide        - The Yocto Project Board Support (BSP) Developer's Guide
* dev-manual       - The Yocto Project Development Manual
* kernel-manual    - The Yocto Project Kernel Architecture and Use Manual
* poky-ref-manual  - The Yocto Project Reference Manual
* yocto-project-qs - The Yocto Project Quick Start

Each folder is self-contained regarding content and figures. 

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 ADT manual.
The DOC variable specifies the manual you are making:

     $ make DOC=adt-manual

poky.ent
========

This file defines variables used for documentation production.  The variables
are used to define release pathnames, URLs for the published manuals, etc.

template
========
Contains various templates, fonts, and some old PNG files.

tools
=====
Contains a tool to convert the DocBook files to PDF format.