diff options
| -rw-r--r-- | plugins/org.yocto.doc.user/about.html.in | 88 | ||||
| -rw-r--r-- | plugins/org.yocto.doc.user/plugin.xml | 18 | ||||
| -rw-r--r-- | plugins/org.yocto.doc.user/toc.xml | 17 | ||||
| -rwxr-xr-x | scripts/generate-doc.sh | 4 |
4 files changed, 84 insertions, 43 deletions
diff --git a/plugins/org.yocto.doc.user/about.html.in b/plugins/org.yocto.doc.user/about.html.in index 5188d3c..c9cc526 100644 --- a/plugins/org.yocto.doc.user/about.html.in +++ b/plugins/org.yocto.doc.user/about.html.in @@ -9,12 +9,12 @@ <h2>About This Content</h2> <p> - <em>December, 2012</em> + <em>April, 2018</em> </p> <h3>License</h3> <p> - Copyright (c) 2010 Intel, Inc. and others. + Copyright (c) 2018 Intel, Inc. and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <br /> @@ -31,12 +31,13 @@ Redistributor's license for terms and conditions of use.</p> <p> <strong> - Yocto Project Quick Start + Yocto Project Quick Build </strong> <br /> <br /> - This short document lets you get started with the Yocto Project - quickly and start building an image. + This short document steps you through the process for a typical image + build using the Yocto Project. You will use Yocto Project to build a + reference embedded OS called Poky. <br /> <br /> <em>License:</em> @@ -49,17 +50,18 @@ git://git.yoctoproject.org/yocto-docs </a> <br /> - <em>Commit:</em> @COMMIT_ID-yocto-project-qs@ + <em>Commit:</em> @COMMIT_ID-brief-yoctoprojectqs@ <br /> <br /> <strong> - Yocto Project Software Development Kit (SDK) Developer's Guide: + Yocto Project Overview and Concepts Manual: </strong> <br /> <br /> - This manual shows you how to setup and use the Software Development - Kit (SDK) and stand-alone cross-development toolchains so you can - develop user-space applications. + This manual introduces the Yocto Project by providing concepts, + software overviews, best-known-methods (BKMs), and any other + high-level introductory information suitable for a new Yocto + Project user. <br /> <br /> <em>License:</em> @@ -72,17 +74,17 @@ git://git.yoctoproject.org/yocto-docs </a> <br /> - <em>Commit:</em> @COMMIT_ID-sdk-manual@ + <em>Commit:</em> @COMMIT_ID-overview-manual@ <br /> <br /> <strong> - Yocto Project Development Manual: + Yocto Project Development Tasks Manual: </strong> <br /> <br /> - This manual describes how to use the Yocto Project to develop - embedded Linux images and user-space applications to run on - targeted devices. + This manual provides relevant procedures necessary for developing in + the Yocto Project environment (i.e. developing embedded Linux images + and user-space applications that run on targeted devices). <br /> <br /> <em>License:</em> @@ -99,12 +101,18 @@ <br /> <br /> <strong> - Yocto Project Reference Manual: + Yocto Project Application Development and the Extensible Software + Development Kit (eSDK): </strong> <br /> <br /> - This manual is the complete reference guide to the Poky component. - It also contains a chapter on Board Support Package (BSP) development. + This manual shows you how to setup and use the Software Development + Kit (SDK) and stand-alone cross-development toolchains so you can + develop user-space applications. + + This manual describes how to use the extensible SDK, popular Eclipse + IDE, and stand-alone cross-development toolchains used for user-space + application development. <br /> <br /> <em>License:</em> @@ -117,7 +125,7 @@ git://git.yoctoproject.org/yocto-docs </a> <br /> - <em>Commit:</em> @COMMIT_ID-ref-manual@ + <em>Commit:</em> @COMMIT_ID-sdk-manual@ <br /> <br /> <strong> @@ -125,8 +133,11 @@ </strong> <br /> <br /> - This brief document defines a structure for BSP components. - Having a commonly understood layout encourages standardization. + This manual presents information about BSP Layers, defines a structure + for components so that BSPs follow a commonly understood layout, + discusses how to customize a recipe for a BSP, addresses BSP licensing, + and provides information that shows you how to create a BSP Layer using + the bitbake-layers tool. <br /> <br /> <em>License:</em> @@ -147,8 +158,9 @@ </strong> <br /> <br /> - This document describes the architecture of the Yocto Project - kernel and provides some work flow examples. + This manual describes how to set up your build host to support kernel + development, introduces the kernel development process, provides + background information on the Yocto Linux kernel Metadata, <br /> <br /> <em>License:</em> @@ -162,16 +174,16 @@ </a> <br /> <em>Commit:</em> @COMMIT_ID-kernel-dev@ - <br /> + <br /> <br /> <strong> Yocto Project Profiling and Tracing Manual: </strong> <br /> <br /> - This manual presents a set of common and generally useful - tracing and profiling schemes along with their application - (as appropriate) to each tool. + This manual describes basic profiling and tracing tools usage. + The manual shows by example how to make use of these tools to examine + application and system behavior. <br /> <br /> <em>License:</em> @@ -185,5 +197,27 @@ </a> <br /> <em>Commit:</em> @COMMIT_ID-profile-manual@ + <br /> + <br /> + <strong> + Yocto Project Reference Manual: + </strong> + <br /> + <br /> + This manual is the complete reference guide to the Poky component. + It also contains a chapter on Board Support Package (BSP) development. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-ref-manual@ </p> </body> diff --git a/plugins/org.yocto.doc.user/plugin.xml b/plugins/org.yocto.doc.user/plugin.xml index c7754de..a5d66ac 100644 --- a/plugins/org.yocto.doc.user/plugin.xml +++ b/plugins/org.yocto.doc.user/plugin.xml @@ -8,11 +8,11 @@ primary="true"> </toc> <toc - file="html/sdk-manual-toc.xml" + file="html/brief-yoctoprojectqs-toc.xml" primary="false"> </toc> <toc - file="html/yocto-project-qs-toc.xml" + file="html/overview-manual-toc.xml" primary="false"> </toc> <toc @@ -20,7 +20,7 @@ primary="false"> </toc> <toc - file="html/ref-manual-toc.xml" + file="html/sdk-manual-toc.xml" primary="false"> </toc> <toc @@ -31,9 +31,13 @@ file="html/kernel-dev-toc.xml" primary="false"> </toc> - <toc - file="html/profile-manual-toc.xml" - primary="false"> - </toc> + <toc + file="html/profile-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/ref-manual-toc.xml" + primary="false"> + </toc> </extension> </plugin> diff --git a/plugins/org.yocto.doc.user/toc.xml b/plugins/org.yocto.doc.user/toc.xml index a390084..8ffb24a 100644 --- a/plugins/org.yocto.doc.user/toc.xml +++ b/plugins/org.yocto.doc.user/toc.xml @@ -1,18 +1,18 @@ <?xml version="1.0" encoding="UTF-8"?> <toc label="Yocto Project Documentation"> - <topic label="Yocto Project Quick Start"> - <link toc="html/yocto-project-qs-toc.xml"/> + <topic label="Yocto Project Quick Build"> + <link toc="html/brief-yoctoprojectqs-toc.xml"/> </topic> - <topic label="Yocto Project Software Development Kit (SDK) Developer's Guide"> - <link toc="html/sdk-manual-toc.xml"/> + <topic label="Yocto Project Overview and Concepts Manual"> + <link toc="html/overview-manual-toc.xml"/> </topic> <topic label="Yocto Project Development Manual"> <link toc="html/dev-manual-toc.xml"/> </topic> - <topic label="Yocto Project Reference Manual"> - <link toc="html/ref-manual-toc.xml"/> + <topic label="Yocto Project Application Development and the Extensible Software Development Kit (eSDK)"> + <link toc="html/sdk-manual-toc.xml"/> </topic> - <topic label="Yocto Project Board Support Package Developer's Guide"> + <topic label="Yocto Project Board Support Package (BSP) Developer's Guide"> <link toc="html/bsp-guide-toc.xml"/> </topic> <topic label="Yocto Project Linux Kernel Development Manual"> @@ -21,4 +21,7 @@ <topic label="Yocto Project Tracing and Profiling Manual"> <link toc="html/profile-manual-toc.xml"/> </topic> + <topic label="Yocto Project Reference Manual"> + <link toc="html/ref-manual-toc.xml"/> + </topic> </toc> diff --git a/scripts/generate-doc.sh b/scripts/generate-doc.sh index 5a4b057..eb781df 100755 --- a/scripts/generate-doc.sh +++ b/scripts/generate-doc.sh @@ -53,8 +53,8 @@ cd ${DOC_DIR} git checkout $1 || fail $? "git checkout $1" COMMIT_ID=`git rev-parse HEAD` -DOCS="sdk-manual kernel-dev \ - bsp-guide ref-manual dev-manual profile-manual" +DOCS="brief-yoctoprojectqs overview-manual dev-manual sdk-manual \ + bsp-guide kernel-dev profile-manual ref-manual" # build and copy cd documentation |