mirror of
https://git.yoctoproject.org/poky
synced 2026-04-30 21:32:13 +02:00
bc6a19d6a7
Fixes [YOCTO #12370] I added all the mechanics for this new "Yocto Project Overview Manual". For now, the manual builds and publishes into the 2.5 area. I used "overview-manual" for the folder name. Makefile properly builds the new manual. The mega-manual.sed file processes links for the new manual. The mega-manual.xml file includes the new manual. The poky.ent file includes a new ENTITY link for the overview manual. All pieces are in place. With this commit, just an overview chapter exists. The remaining content needs to be developed. (From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
112 lines
9.9 KiB
HTML
112 lines
9.9 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yocto Project Overview Manual</title><link rel="stylesheet" type="text/css" href="overview-style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="book" title="Yocto Project Overview Manual" id="overview-manual" lang="en"><div class="titlepage"><div><div><h1 class="title">
|
||
Yocto Project Overview Manual
|
||
</h1></div><div><div class="authorgroup">
|
||
<div class="author"><h3 class="author"><span class="firstname">Scott</span> <span class="surname">Rifenbark</span></h3><div class="affiliation">
|
||
<span class="orgname">Scotty's Documentation Services, INC<br /></span>
|
||
</div><code class="email"><<a class="email" href="mailto:srifenbark@gmail.com">srifenbark@gmail.com</a>></code></div>
|
||
</div></div><div><p class="copyright">Copyright © 2010-2018 Linux Foundation</p></div><div><div class="legalnotice" title="Legal Notice"><a id="idm45825624227376"></a>
|
||
<p>
|
||
Permission is granted to copy, distribute and/or modify this document under
|
||
the terms of the <a class="ulink" href="http://creativecommons.org/licenses/by-sa/2.0/uk/" target="_top">
|
||
Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</a> as published by
|
||
Creative Commons.
|
||
</p>
|
||
<div class="note" title="Manual Notes" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Manual Notes</h3>
|
||
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
|
||
This version of the
|
||
<span class="emphasis"><em>Yocto Project Overview Manual</em></span>
|
||
is for the 2.5 release of the
|
||
Yocto Project.
|
||
To be sure you have the latest version of the manual
|
||
for this release, use the manual from the
|
||
<a class="ulink" href="http://www.yoctoproject.org/documentation" target="_top">Yocto Project documentation page</a>.
|
||
</p></li><li class="listitem"><p>
|
||
For manuals associated with other releases of the Yocto
|
||
Project, go to the
|
||
<a class="ulink" href="http://www.yoctoproject.org/documentation" target="_top">Yocto Project documentation page</a>
|
||
and use the drop-down "Active Releases" button
|
||
and choose the manual associated with the desired
|
||
Yocto Project.
|
||
</p></li><li class="listitem"><p>
|
||
To report any inaccuracies or problems with this
|
||
manual, send an email to the Yocto Project
|
||
discussion group at
|
||
<code class="filename">yocto@yoctoproject.com</code> or log into
|
||
the freenode <code class="filename">#yocto</code> channel.
|
||
</p></li></ul></div>
|
||
</div>
|
||
</div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><strong>Revision History</strong></th></tr>
|
||
<tr><td align="left">Revision 2.5</td><td align="left">April 2018</td></tr><tr><td align="left" colspan="2">The initial document released with the Yocto Project 2.5 Release.</td></tr>
|
||
</table></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="chapter"><a href="#overview-manual-intro">1. The Yocto Project Overview Manual</a></span></dt><dd><dl><dt><span class="section"><a href="#overview-welcome">1.1. Welcome</a></span></dt><dt><span class="section"><a href="#overview-other-information">1.2. Other Information</a></span></dt></dl></dd></dl></div>
|
||
|
||
|
||
<div class="chapter" title="Chapter 1. The Yocto Project Overview Manual" id="overview-manual-intro"><div class="titlepage"><div><div><h2 class="title">Chapter 1. The Yocto Project Overview Manual<span class="permalink"><a alt="Permalink" title="Permalink" href="#overview-manual-intro">¶</a></span></h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#overview-welcome">1.1. Welcome</a></span></dt><dt><span class="section"><a href="#overview-other-information">1.2. Other Information</a></span></dt></dl></div><div class="section" title="1.1. Welcome"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="overview-welcome">1.1. Welcome<span class="permalink"><a alt="Permalink" title="Permalink" href="#overview-welcome">¶</a></span></h2></div></div></div><p>
|
||
Welcome to the Yocto Project Overview Manual!
|
||
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.
|
||
</p><p>
|
||
The following list describes what you can get from this manual:
|
||
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
|
||
<span class="emphasis"><em>Major Topic:</em></span>
|
||
Provide a high-level description of this major topic.
|
||
</p></li><li class="listitem"><p>
|
||
<span class="emphasis"><em>Major Topic:</em></span>
|
||
Provide a high-level description of this major topic.
|
||
</p></li><li class="listitem"><p>
|
||
<span class="emphasis"><em>Major Topic:</em></span>
|
||
Provide a high-level description of this major topic.
|
||
</p></li><li class="listitem"><p>
|
||
<span class="emphasis"><em>Major Topic:</em></span>
|
||
Provide a high-level description of this major topic.
|
||
</p></li></ul></div><p>
|
||
</p><p>
|
||
This manual does not give you the following:
|
||
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
|
||
<span class="emphasis"><em>Step-by-step Instructions for Development Tasks:</em></span>
|
||
Instructional procedures reside in other manuals within
|
||
the Yocto Project documentation set.
|
||
For example, the
|
||
<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a>
|
||
provides examples on how to perform various development
|
||
tasks.
|
||
As another example, the
|
||
<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</a>
|
||
manual contains detailed instructions on how to install an
|
||
SDK, which is used to develop applications for target
|
||
hardware.
|
||
</p></li><li class="listitem"><p>
|
||
<span class="emphasis"><em>Reference Material:</em></span>
|
||
This type of material resides in an appropriate reference
|
||
manual.
|
||
For example, system variables are documented in the
|
||
<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/ref-manual/ref-manual.html" target="_top">Yocto Project Reference Manual</a>.
|
||
As another example, the
|
||
<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/bsp-guide/bsp-guide.html" target="_top">Yocto Project Board Support Package (BSP) Developer's Guide</a>
|
||
contains reference information on BSPs.
|
||
</p></li><li class="listitem"><p>
|
||
<span class="emphasis"><em>Detailed Public Information Not Specific to the
|
||
Yocto Project:</em></span>
|
||
For example, exhaustive information on how to use the
|
||
Source Control Manager Git is better covered with Internet
|
||
searches and official Git Documentation than through the
|
||
Yocto Project documentation.
|
||
</p></li></ul></div><p>
|
||
</p></div><div class="section" title="1.2. Other Information"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="overview-other-information">1.2. Other Information<span class="permalink"><a alt="Permalink" title="Permalink" href="#overview-other-information">¶</a></span></h2></div></div></div><p>
|
||
Because this manual presents information for many different
|
||
topics, supplemental information is recommended for full
|
||
comprehension.
|
||
For additional introductory information on the Yocto Project, see
|
||
the <a class="ulink" href="http://www.yoctoproject.org" target="_top">Yocto Project Website</a>.
|
||
You can find an introductory to using the Yocto Project by working
|
||
through the
|
||
<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/yocto-project-qs/yocto-project-qs.html" target="_top">Yocto Project Quick Start</a>.
|
||
</p><p>
|
||
For a comprehensive list of links and other documentation, see the
|
||
"<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/ref-manual/ref-manual.html#resources-links-and-related-documentation" target="_top">Links and Related Documentation</a>"
|
||
section in the Yocto Project Reference Manual.
|
||
</p></div></div>
|
||
|
||
</div></body></html> |