| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1 | documentation |
| 2 | ============= |
| 3 | |
| 4 | This is the directory that contains the Yocto Project documentation. The Yocto |
| 5 | Project source repositories at http://git.yoctoproject.org/cgit.cgi have two |
| 6 | instances of the "documentation" directory. You should understand each of |
| 7 | these 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 | |
| 32 | Manual Organization |
| 33 | =================== |
| 34 | |
| 35 | Folders exist for individual manuals as follows: |
| 36 | |
| 37 | * adt-manual - The Yocto Project Application Developer's Guide. |
| 38 | * bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide |
| 39 | * dev-manual - The Yocto Project Development Manual |
| 40 | * kernel-dev - The Yocto Project Linux Kernel Development Manual |
| 41 | * ref-manual - The Yocto Project Reference Manual |
| 42 | * yocto-project-qs - The Yocto Project Quick Start |
| 43 | * mega-manual - An aggregated manual comprised of all YP manuals and guides |
| 44 | * profile-manual - The Yocto Project Profile and Tracing Manual |
| 45 | |
| 46 | Each folder is self-contained regarding content and figures. Note that there |
| 47 | is a sed file needed to process the links of the mega-manual. The sed file |
| 48 | is located in the tools directory. Also note that the figures folder in the |
| 49 | mega-manual directory contains duplicates of all the figures in the YP folders |
| 50 | directories for all YP manuals and guides. |
| 51 | |
| 52 | If you want to find HTML versions of the Yocto Project manuals on the web, |
| 53 | go to http://www.yoctoproject.org and click on the "Documentation" tab. From |
| 54 | there you have access to archived documentation from previous releases, current |
| 55 | documentation for the latest release, and "Docs in Progress" for the release |
| 56 | currently being developed. |
| 57 | |
| 58 | In general, the Yocto Project site (http://www.yoctoproject.org) is a great |
| 59 | reference for both information and downloads. |
| 60 | |
| 61 | Makefile |
| 62 | ======== |
| 63 | |
| 64 | The Makefile processes manual directories to create HTML, PDF, |
| 65 | tarballs, etc. Details on how the Makefile work are documented |
| 66 | inside the Makefile. See that file for more information. |
| 67 | |
| 68 | To build a manual, you run the make command and pass it the name |
| 69 | of the folder containing the manual's contents. |
| 70 | For example, the following command run from the documentation directory |
| 71 | creates an HTML and a PDF version of the ADT manual. |
| 72 | The DOC variable specifies the manual you are making: |
| 73 | |
| 74 | $ make DOC=adt-manual |
| 75 | |
| 76 | poky.ent |
| 77 | ======== |
| 78 | |
| 79 | This file defines variables used for documentation production. The variables |
| 80 | are used to define release pathnames, URLs for the published manuals, etc. |
| 81 | |
| 82 | template |
| 83 | ======== |
| 84 | Contains various templates, fonts, and some old PNG files. |
| 85 | |
| 86 | tools |
| 87 | ===== |
| 88 | Contains a tool to convert the DocBook files to PDF format. This folder also |
| 89 | contains the mega-manual.sed file, which is used by Makefile to process |
| 90 | cross-references from within the manual that normally go to an external |
| 91 | manual. |