blob: d64f2fd2f96afd301f0c5d865e1478b3a8bb1bc6 [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001documentation
2=============
3
4This is the directory that contains the Yocto Project documentation. The Yocto
5Project source repositories at http://git.yoctoproject.org/cgit.cgi have two
6instances of the "documentation" directory. You should understand each of
7these instances.
8
9 poky/documentation - The directory within the poky Git repository containing
10 the set of Yocto Project manuals. When you clone the
11 poky Git repository, the documentation directory
12 contains the manuals. The state of the manuals in this
13 directory is guaranteed to reflect the latest Yocto
14 Project release. The manuals at the tip of this
15 directory will also likely contain most manual
16 development changes.
17
18 yocto-docs/documentation - The Git repository for the Yocto Project manuals.
19 This repository is where manual development
20 occurs. If you plan on contributing back to the
21 Yocto Project documentation, you should set up
22 a local Git repository based on this upstream
23 repository as follows:
24
25 git clone git://git.yoctoproject.org/yocto-docs
26
27 Changes and patches are first pushed to the
28 yocto-docs Git repository. Later, they make it
29 into the poky Git repository found at
30 git://git.yoctoproject.org/poky.
31
32Manual Organization
33===================
34
35Folders exist for individual manuals as follows:
36
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050037* sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050038* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide
Brad Bishopd7bf8c12018-02-25 22:55:05 -050039* dev-manual - The Yocto Project Development Tasks Manual
40* kernel-dev - The Yocto Project Linux Kernel Development Tasks Manual
Patrick Williamsc124f4f2015-09-15 14:41:29 -050041* ref-manual - The Yocto Project Reference Manual
42* yocto-project-qs - The Yocto Project Quick Start
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050043* mega-manual - The Yocto Project Mega-Manual, which is an aggregated manual comprised
44 of all YP manuals and guides
Patrick Williamsc124f4f2015-09-15 14:41:29 -050045* profile-manual - The Yocto Project Profile and Tracing Manual
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050046* toaster-manual - The Toaster Manual
Patrick Williamsc124f4f2015-09-15 14:41:29 -050047
48Each folder is self-contained regarding content and figures. Note that there
49is a sed file needed to process the links of the mega-manual. The sed file
50is located in the tools directory. Also note that the figures folder in the
51mega-manual directory contains duplicates of all the figures in the YP folders
52directories for all YP manuals and guides.
53
54If you want to find HTML versions of the Yocto Project manuals on the web,
55go to http://www.yoctoproject.org and click on the "Documentation" tab. From
56there you have access to archived documentation from previous releases, current
57documentation for the latest release, and "Docs in Progress" for the release
58currently being developed.
59
60In general, the Yocto Project site (http://www.yoctoproject.org) is a great
61reference for both information and downloads.
62
63Makefile
64========
65
66The Makefile processes manual directories to create HTML, PDF,
67tarballs, etc. Details on how the Makefile work are documented
68inside the Makefile. See that file for more information.
69
70To build a manual, you run the make command and pass it the name
71of the folder containing the manual's contents.
72For example, the following command run from the documentation directory
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050073creates an HTML version of the SDK manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050074The DOC variable specifies the manual you are making:
75
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050076 $ make DOC=sdk-manual
Patrick Williamsc124f4f2015-09-15 14:41:29 -050077
78poky.ent
79========
80
81This file defines variables used for documentation production. The variables
82are used to define release pathnames, URLs for the published manuals, etc.
83
84template
85========
86Contains various templates, fonts, and some old PNG files.
87
88tools
89=====
90Contains a tool to convert the DocBook files to PDF format. This folder also
91contains the mega-manual.sed file, which is used by Makefile to process
92cross-references from within the manual that normally go to an external
93manual.