diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-04-05 17:26:43 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-04-06 23:11:58 +0100 |
commit | d9b4c804be3345d7782942cba4e9d9a3fd0891d0 (patch) | |
tree | 192254cbfef7079f275a0991534500b2683cdbcc /documentation | |
parent | 9796cbbf4fdf2ae08d9d78192234eb7ff1811440 (diff) | |
download | poky-d9b4c804be3345d7782942cba4e9d9a3fd0891d0.tar.gz |
README: Updated to remove the ADT manual and add the SDK manual.
(From yocto-docs rev: 61474479f84e2f611684db152e7682275f8f19c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/README | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/documentation/README b/documentation/README index d01678d4f4..a4e70a8721 100644 --- a/documentation/README +++ b/documentation/README | |||
@@ -34,14 +34,16 @@ Manual Organization | |||
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 Developer's Guide. | 37 | * sdk-manual - The Yocto Project Software Development Kit (SDK) Developer's Guide. |
38 | * bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide | 38 | * bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide |
39 | * dev-manual - The Yocto Project Development Manual | 39 | * dev-manual - The Yocto Project Development Manual |
40 | * kernel-dev - The Yocto Project Linux Kernel Development Manual | 40 | * kernel-dev - The Yocto Project Linux Kernel Development Manual |
41 | * ref-manual - The Yocto Project Reference Manual | 41 | * ref-manual - The Yocto Project Reference Manual |
42 | * yocto-project-qs - The Yocto Project Quick Start | 42 | * yocto-project-qs - The Yocto Project Quick Start |
43 | * mega-manual - An aggregated manual comprised of all YP manuals and guides | 43 | * mega-manual - The Yocto Project Mega-Manual, which is an aggregated manual comprised |
44 | of all YP manuals and guides | ||
44 | * profile-manual - The Yocto Project Profile and Tracing Manual | 45 | * profile-manual - The Yocto Project Profile and Tracing Manual |
46 | * toaster-manual - The Toaster Manual | ||
45 | 47 | ||
46 | Each folder is self-contained regarding content and figures. Note that there | 48 | 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 | 49 | is a sed file needed to process the links of the mega-manual. The sed file |
@@ -68,10 +70,10 @@ inside the Makefile. See that file for more information. | |||
68 | To build a manual, you run the make command and pass it the name | 70 | To build a manual, you run the make command and pass it the name |
69 | of the folder containing the manual's contents. | 71 | of the folder containing the manual's contents. |
70 | For example, the following command run from the documentation directory | 72 | For example, the following command run from the documentation directory |
71 | creates an HTML and a PDF version of the ADT manual. | 73 | creates an HTML version of the SDK manual. |
72 | The DOC variable specifies the manual you are making: | 74 | The DOC variable specifies the manual you are making: |
73 | 75 | ||
74 | $ make DOC=adt-manual | 76 | $ make DOC=sdk-manual |
75 | 77 | ||
76 | poky.ent | 78 | poky.ent |
77 | ======== | 79 | ======== |