MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity
b64ad8ba85
poky/documentation
History
Paul Eggleton b64ad8ba85 dev-manual: menuconfig now works properly 
Bug 2256 is now fixed in master and the fix will be in the next release,
so update the documentation accordingly.

(From yocto-docs rev: 877a7ecfd1623417d0793a5dd16b66c35b6fdbae)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-04 14:48:16 +01:00
..
adt-manual documentation/adt-manual: Adjustments to Yocto Project term 2012-06-29 13:31:02 +01:00
bsp-guide documentation/bsp-guide/bsp.xml: Yocto term paring 2012-07-02 16:47:45 +01:00
dev-manual dev-manual: menuconfig now works properly 2012-07-04 14:48:16 +01:00
kernel-manual documentation/kernel-manual: Scrubbed the Yocto Project term 2012-07-03 14:55:02 +01:00
poky-ref-manual shared state memory -> shared state cache 2012-07-04 14:48:16 +01: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: Updated Fedora packages 2012-06-26 15:34:39 +01:00
Makefile documentation/Makefile: Fixed figures publishing bug 2012-05-01 20:50:56 +01:00
poky.ent poky-ref-manual: update mailing list info in ref manual 2012-07-03 14:55:04 +01:00
README documentation/README: Updates to explain development 2012-03-23 14:24:48 +00:00

README

documentation

This is the directory that contains the Yocto Project documentation. The Yocto Project source repositories at http://git.yoctoproject.org/cgit.cgi have two instances of the "documentation" directory. You should understand each of these instances.

poky/documentation - The directory within the poky Git repository containing the set of Yocto Project manuals. When you clone the poky Git repository, the documentation directory contains the manuals. The state of the manuals in this directory is guaranteed to reflect the latest Yocto Project release. The manuals at the tip of this directory will also likely contain most manual development changes.

yocto-docs/documentation - The Git repository for the Yocto Project manuals.
This repository is where manual development occurs. If you plan on contributing back to the Yocto Project documentation, you should set up a local Git repository based on this upstream repository as follows:

                           git clone git://git.yoctoproject.org/yocto-docs

                         Changes and patches are first pushed to the 
                         yocto-docs Git repository.  Later, they make it 
                         into the poky Git repository found at 
                         git://git.yoctoproject.org/poky.

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.