diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-07-08 10:57:48 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-08-13 13:18:36 +0100 |
commit | d917158ff68cbdddd1c1b3506df899c9acea86ac (patch) | |
tree | 66fdbbe468ca376849f3dfbe4abfa556fae4f605 /documentation | |
parent | e5dae1b9809aef993c6e2abd3769ae1337de7bc2 (diff) | |
download | poky-d917158ff68cbdddd1c1b3506df899c9acea86ac.tar.gz |
README: Updated the file to reflect current state of documentation
This file was out of date. I replaced the kernel-manual descriptions
with dev-kernel. Also, added the profiling manual. Finally, changed
the poky-ref-manual string to ref-manual.
(From yocto-docs rev: a1e60078dcfcfd5a912d78f981fe70dc1aa33e37)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/README | 65 |
1 files changed, 31 insertions, 34 deletions
diff --git a/documentation/README b/documentation/README index 911484cb99..d01678d4f4 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -2,60 +2,60 @@ documentation | |||
2 | ============= | 2 | ============= |
3 | 3 | ||
4 | This is the directory that contains the Yocto Project documentation. The Yocto | 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 | 5 | Project source repositories at http://git.yoctoproject.org/cgit.cgi have two |
6 | instances of the "documentation" directory. You should understand each of | 6 | instances of the "documentation" directory. You should understand each of |
7 | these instances. | 7 | these instances. |
8 | 8 | ||
9 | poky/documentation - The directory within the poky Git repository containing | 9 | poky/documentation - The directory within the poky Git repository containing |
10 | the set of Yocto Project manuals. When you clone the | 10 | the set of Yocto Project manuals. When you clone the |
11 | poky Git repository, the documentation directory | 11 | poky Git repository, the documentation directory |
12 | contains the manuals. The state of the manuals in this | 12 | contains the manuals. The state of the manuals in this |
13 | directory is guaranteed to reflect the latest Yocto | 13 | directory is guaranteed to reflect the latest Yocto |
14 | Project release. The manuals at the tip of this | 14 | Project release. The manuals at the tip of this |
15 | directory will also likely contain most manual | 15 | directory will also likely contain most manual |
16 | development changes. | 16 | development changes. |
17 | 17 | ||
18 | yocto-docs/documentation - The Git repository for the Yocto Project manuals. | 18 | yocto-docs/documentation - The Git repository for the Yocto Project manuals. |
19 | This repository is where manual development | 19 | This repository is where manual development |
20 | occurs. If you plan on contributing back to the | 20 | occurs. If you plan on contributing back to the |
21 | Yocto Project documentation, you should set up | 21 | Yocto Project documentation, you should set up |
22 | a local Git repository based on this upstream | 22 | a local Git repository based on this upstream |
23 | repository as follows: | 23 | repository as follows: |
24 | 24 | ||
25 | git clone git://git.yoctoproject.org/yocto-docs | 25 | git clone git://git.yoctoproject.org/yocto-docs |
26 | 26 | ||
27 | Changes and patches are first pushed to the | 27 | Changes and patches are first pushed to the |
28 | yocto-docs Git repository. Later, they make it | 28 | yocto-docs Git repository. Later, they make it |
29 | into the poky Git repository found at | 29 | into the poky Git repository found at |
30 | git://git.yoctoproject.org/poky. | 30 | git://git.yoctoproject.org/poky. |
31 | 31 | ||
32 | Manual Organization | 32 | Manual Organization |
33 | =================== | 33 | =================== |
34 | 34 | ||
35 | Folders exist for individual manuals as follows: | 35 | Folders exist for individual manuals as follows: |
36 | 36 | ||
37 | * adt-manual - The Yocto Project Application Development Toolkit (ADT) | 37 | * adt-manual - The Yocto Project Application Developer's Guide. |
38 | User's Guide. | 38 | * bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide |
39 | * bsp-guide - The Yocto Project Board Support (BSP) Developer's Guide | ||
40 | * dev-manual - The Yocto Project Development Manual | 39 | * dev-manual - The Yocto Project Development Manual |
41 | * kernel-manual - The Yocto Project Kernel Architecture and Use Manual | 40 | * kernel-dev - The Yocto Project Linux Kernel Development Manual |
42 | * poky-ref-manual - The Yocto Project Reference Manual | 41 | * ref-manual - The Yocto Project Reference Manual |
43 | * yocto-project-qs - The Yocto Project Quick Start | 42 | * yocto-project-qs - The Yocto Project Quick Start |
44 | * mega-manual - The aggregated manual comprised of all YP manuals and guides | 43 | * mega-manual - An aggregated manual comprised of all YP manuals and guides |
44 | * profile-manual - The Yocto Project Profile and Tracing Manual | ||
45 | 45 | ||
46 | Each folder is self-contained regarding content and figures. Note that there | 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 | 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 | 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 | 49 | mega-manual directory contains duplicates of all the figures in the YP folders |
50 | directories for all YP manuals and guides. | 50 | directories for all YP manuals and guides. |
51 | 51 | ||
52 | If you want to find HTML versions of the Yocto Project manuals on the web, | 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 | 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 | 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 | 55 | documentation for the latest release, and "Docs in Progress" for the release |
56 | currently being developed. | 56 | currently being developed. |
57 | 57 | ||
58 | In general, the Yocto Project site (http://www.yoctoproject.org) is a great | 58 | In general, the Yocto Project site (http://www.yoctoproject.org) is a great |
59 | reference for both information and downloads. | 59 | reference for both information and downloads. |
60 | 60 | ||
61 | Makefile | 61 | Makefile |
@@ -66,8 +66,8 @@ tarballs, etc. Details on how the Makefile work are documented | |||
66 | inside the Makefile. See that file for more information. | 66 | inside the Makefile. See that file for more information. |
67 | 67 | ||
68 | To build a manual, you run the make command and pass it the name | 68 | To build a manual, you run the make command and pass it the name |
69 | of the folder containing the manual's contents. | 69 | of the folder containing the manual's contents. |
70 | For example, the following command run from the documentation directory | 70 | For example, the following command run from the documentation directory |
71 | creates an HTML and a PDF version of the ADT manual. | 71 | creates an HTML and a PDF version of the ADT manual. |
72 | The DOC variable specifies the manual you are making: | 72 | The DOC variable specifies the manual you are making: |
73 | 73 | ||
@@ -86,9 +86,6 @@ Contains various templates, fonts, and some old PNG files. | |||
86 | tools | 86 | tools |
87 | ===== | 87 | ===== |
88 | Contains a tool to convert the DocBook files to PDF format. This folder also | 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 | 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 | 90 | cross-references from within the manual that normally go to an external |
91 | manual. | 91 | manual. |
92 | |||
93 | |||
94 | |||