dev-manual, ref-manual: Reorganized "Other Information"

Fixes [YOCTO #11630]

The exhaustive list of useful links and references to other
YP documentation existed in the dev-manual.  This is not the correct
place for this type of reference information.  I have moved that
list to the ref-manual where it should be.  The dev-manual now
simply provides a link into that section.

(From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2017-06-13 10:10:51 -07:00
committed by Richard Purdie
parent 741dddf11a
commit ed0ecc7b76
3 changed files with 274 additions and 230 deletions

View File

@@ -109,144 +109,13 @@
<title>Other Information</title>
<para>
Because this manual presents overview information for many different
Because this manual presents information for many different
topics, supplemental information is recommended for full
comprehension.
The following list presents other sources of information you might find helpful:
<itemizedlist>
<listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
</emphasis> The home page for the Yocto Project provides lots of information on the project
as well as links to software and documentation.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis>
This short document lets you get started
with the Yocto Project and quickly begin building an image.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis>
This manual is a reference
guide to the OpenEmbedded build system, which is based on BitBake.
The build system is sometimes referred to as "Poky".
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>:</emphasis>
This guide provides information that lets you get going
with the standard or extensible SDK.
An SDK, with its cross-development toolchains, allows you
to develop projects inside or outside of the Yocto Project
environment.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
This guide defines the structure for BSP components.
Having a commonly understood structure encourages standardization.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis>
This manual describes how to work with Linux Yocto kernels as well as provides a bit
of conceptual information on the construction of the Yocto Linux kernel tree.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis>
This manual presents a set of common and generally useful tracing and
profiling schemes along with their applications (as appropriate) to each tool.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:</emphasis>
This manual introduces and describes how to set up and use
Toaster, which is a web interface to the Yocto Project's
<link linkend='build-system-term'>OpenEmbedded Build System</link>.
</para></listitem>
<!--
<listitem><para><emphasis>
<ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'>
Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
A step-by-step instructional video that
demonstrates how an application developer uses Yocto Plug-in features within
the Eclipse IDE.
</para></listitem>
-->
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-appendix-latest-yp-eclipse-plug-in'>Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
Instructions that demonstrate how an application developer
uses the Eclipse Yocto Project Plug-in feature within
the Eclipse IDE.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
A list of commonly asked questions and their answers.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
Features, updates and known issues for the current
release of the Yocto Project.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>:</emphasis>
An Application Programming Interface (API) and web-based
interface to the OpenEmbedded build system, which uses
BitBake, that reports build information.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:</emphasis>
A virtual machine that
enables you to build and boot a custom embedded Linux image
with the Yocto Project using a non-Linux development system.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
The bug tracking application the Yocto Project uses.
If you find problems with the Yocto Project, you should report them using this
application.
</para></listitem>
<listitem><para><emphasis>Yocto Project Mailing Lists:</emphasis>
To subscribe to the Yocto Project mailing
lists, click on the following URLs and follow the instructions:
<itemizedlist>
<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink>
for a Yocto Project Discussions mailing list.
</para></listitem>
<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink>
for a Yocto Project Discussions mailing list about the
OpenEmbedded build system (Poky).
</para></listitem>
<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
for a mailing list to receive official Yocto Project announcements
as well as Yocto Project milestones.
</para></listitem>
<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink>
for a listing of all public mailing lists on
<filename>lists.yoctoproject.org</filename>.
</para></listitem>
</itemizedlist></para></listitem>
<listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
Two IRC channels on freenode are available
for Yocto Project and Poky discussions: <filename>#yocto</filename> and
<filename>#poky</filename>, respectively.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
The build system used by the Yocto Project.
This project is the upstream, generic, embedded distribution
from which the Yocto Project derives its build system (Poky)
and to which it contributes.
</para></listitem>
<listitem><para><emphasis>
<ulink url='http://www.openembedded.org/wiki/BitBake'>BitBake</ulink>:</emphasis>
The tool used by the OpenEmbedded build system
to process project metadata.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis>
A comprehensive guide to the BitBake tool.
If you want information on BitBake, see this manual.
</para></listitem>
<listitem><para><emphasis>
<ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:</emphasis>
An open-source machine emulator and virtualizer.
</para></listitem>
</itemizedlist>
See the
"<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>"
section in the Yocto Project Reference Manual for helpful
sources.
</para>
</section>
</chapter>

View File

@@ -44,75 +44,114 @@
<para>
This reference manual consists of the following:
<itemizedlist>
<listitem><para><emphasis>
<link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis>
Provides an overview of the components that make up the Yocto Project
followed by information about debugging images created in the Yocto Project.
<listitem><para>
<emphasis>
<link linkend='usingpoky'>Using the Yocto Project</link>:
</emphasis>
Provides an overview of the components that make up the Yocto
Project followed by information about debugging images created
in the Yocto Project.
</para></listitem>
<listitem><para><emphasis>
<link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>:</emphasis>
<listitem><para>
<emphasis>
<link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>:
</emphasis>
Provides a more detailed look at the Yocto Project development
environment within the context of development.
</para></listitem>
<listitem><para><emphasis>
<link linkend='technical-details'>Technical Details</link>:</emphasis>
Describes fundamental Yocto Project components as well as an explanation
behind how the Yocto Project uses shared state (sstate) cache to speed build time.
<listitem><para>
<emphasis>
<link linkend='technical-details'>Technical Details</link>:
</emphasis>
Describes fundamental Yocto Project components as well as an
explanation behind how the Yocto Project uses shared state
(sstate) cache to speed build time.
</para></listitem>
<listitem><para><emphasis>
<link linkend='migration'>Migrating to a Newer Yocto Project Release</link>:</emphasis>
<listitem><para>
<emphasis>
<link linkend='migration'>Migrating to a Newer Yocto Project Release</link>:
</emphasis>
Describes release-specific information that helps you move from
one Yocto Project Release to another.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-structure'>Directory Structure</link>:</emphasis>
Describes the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> created
either by unpacking a released Yocto Project tarball on your host development system,
or by cloning the upstream
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
<listitem><para>
<emphasis>
<link linkend='ref-structure'>Directory Structure</link>:
</emphasis> Describes the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
created either by unpacking a released Yocto Project tarball on
your host development system, or by cloning the upstream
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>
Git repository.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-classes'>Classes</link>:</emphasis>
Describes the classes used in the Yocto Project.</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-tasks'>Tasks</link>:</emphasis>
<listitem><para>
<emphasis>
<link linkend='ref-classes'>Classes</link>:
</emphasis>
Describes the classes used in the Yocto Project.
</para></listitem>
<listitem><para>
<emphasis>
<link linkend='ref-tasks'>Tasks</link>:
</emphasis>
Describes the tasks defined by the OpenEmbedded build system.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>:</emphasis>
<listitem><para>
<emphasis>
<link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>:
</emphasis>
Provides a quick reference for the <filename>devtool</filename>
command.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>:</emphasis>
<listitem><para>
<emphasis>
<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>:
</emphasis>
Lists and describes QA warning and error messages.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-images'>Images</link>:</emphasis>
<listitem><para>
<emphasis>
<link linkend='ref-images'>Images</link>:
</emphasis>
Describes the standard images that the Yocto Project supports.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-features'>Features</link>:</emphasis>
Describes mechanisms for creating distribution, machine, and image
features during the build process using the OpenEmbedded build system.</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis>
Presents most variables used by the OpenEmbedded build system, which
uses BitBake.
Entries describe the function of the variable and how to apply them.
<listitem><para>
<emphasis>
<link linkend='ref-features'>Features</link>:
</emphasis>
Describes mechanisms for creating distribution, machine, and
image features during the build process using the OpenEmbedded
build system.
</para></listitem>
<listitem><para>
<emphasis>
<link linkend='ref-variables-glos'>Variables Glossary</link>:
</emphasis>
Presents most variables used by the OpenEmbedded build system,
which uses BitBake.
Entries describe the function of the variable and how to
apply them.
</para></listitem>
<listitem><para>
<emphasis>
<link linkend='ref-varlocality'>Variable Context</link>:
</emphasis>
Provides variable locality or context.
</para></listitem>
<listitem><para>
<emphasis>
<link linkend='faq'>FAQ</link>:
</emphasis>
Provides answers for commonly asked questions in the Yocto
Project development environment.
</para></listitem>
<listitem><para>
<emphasis>
<link linkend='resources'>Contributions and Additional Information</link>:
</emphasis>
Provides an overview of methods by which you can
contribute to and participate in the Yocto Project.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-varlocality'>Variable Context</link>:</emphasis>
Provides variable locality or context.</para></listitem>
<listitem><para><emphasis>
<link linkend='faq'>FAQ</link>:</emphasis>
Provides answers for commonly asked questions in the Yocto Project
development environment.</para></listitem>
<listitem><para><emphasis>
<link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis>
Provides guidance on how you can contribute back to the Yocto
Project.</para></listitem>
</itemizedlist>
</para>
</section>

View File

@@ -3,15 +3,31 @@
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='resources'>
<title>Contributing to the Yocto Project</title>
<title>Contributions and Additional Information</title>
<section id='resources-intro'>
<title>Introduction</title>
<para>
The Yocto Project team is happy for people to experiment with the Yocto Project.
A number of places exist to find help if you run into difficulties or find bugs.
To find out how to download source code,
see the "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto Project Release</ulink>"
The Yocto Project team is happy for people to experiment with the
Yocto Project.
A number of places exist to find help if you run into difficulties
or find bugs.
This presents information about contributing and participating in
the Yocto Project.
</para>
</section>
<section id='resources-contributions'>
<title>Contributions</title>
<para>
The Yocto Project gladly accepts contributions.
You can submit changes to the project either by creating and sending
pull requests,
or by submitting patches through email.
For information on how to do both as well as information on how
to identify the maintainer for each area of code, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>"
section in the Yocto Project Development Manual.
</para>
</section>
@@ -100,53 +116,173 @@
</para>
</section>
<section id='resources-links'>
<title>Links</title>
<section id='resources-links-and-related-documentation'>
<title>Links and Related Documentation</title>
<para>
Here is a list of resources you will find helpful:
Here is a list of resources you might find helpful:
<itemizedlist>
<listitem><para><emphasis>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>:
</emphasis> The home site for the Yocto
Project.</para></listitem>
<!--
<listitem><para><emphasis>
<ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis>
The company that acquired OpenedHand in 2008 and began
development on the Yocto Project.</para></listitem>
-->
<listitem><para><emphasis>
<ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
The upstream, generic, embedded distribution used as the basis
for the build system in the Yocto Project.
Poky derives from and contributes back to the OpenEmbedded
project.</para></listitem>
<listitem><para><emphasis>
</emphasis> The home site for the Yocto Project.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_WIKI_URL;/wiki/Main_Page'>The Yocto Project Main Wiki Page</ulink>:
</emphasis>
The main wiki page for the Yocto Project.
This page contains information about project planning,
release engineering, QA &amp; automation, a reference
site map, and other resources related to the Yocto Project.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:
</emphasis>
The build system used by the Yocto Project.
This project is the upstream, generic, embedded distribution
from which the Yocto Project derives its build system (Poky)
and to which it contributes.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='http://www.openembedded.org/wiki/BitBake'>
BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
BitBake</ulink>:
</emphasis> The tool used to process metadata.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink>
</emphasis>
A comprehensive guide to the BitBake tool.
If you want information on BitBake, see this manual.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:
</emphasis>
This short document lets you get started
with the Yocto Project and quickly begin building an image.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>:
</emphasis>
This manual is a "how-to" guide that presents procedures
useful to both application and system developers who use the
Yocto Project.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>:
</emphasis>
This guide provides information that lets you get going
with the standard or extensible SDK.
An SDK, with its cross-development toolchains, allows you
to develop projects inside or outside of the Yocto Project
environment.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:
</emphasis>
This guide defines the structure for BSP components.
Having a commonly understood structure encourages
standardization.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:
</emphasis>
This manual describes how to work with Linux Yocto kernels as
well as provides a bit of conceptual information on the
construction of the Yocto Linux kernel tree.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:
</emphasis>
This manual presents a set of common and generally useful
tracing and profiling schemes along with their applications
(as appropriate) to each tool.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-appendix-latest-yp-eclipse-plug-in'>Eclipse IDE Yocto Plug-in</ulink>:
</emphasis>
Instructions that demonstrate how an application developer
uses the Eclipse Yocto Project Plug-in feature within
the Eclipse IDE.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:
</emphasis>
A list of commonly asked questions and their answers.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:
</emphasis>
Features, updates and known issues for the current
release of the Yocto Project.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/toaster'>Toaster</ulink>:
</emphasis>
An Application Programming Interface (API) and web-based
interface to the OpenEmbedded build system, which uses
BitBake, that reports build information.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:
</emphasis>
This manual introduces and describes how to set up and use
Toaster, which is a web interface to the Yocto Project's
<ulink url='&YOCTO_DOCS_DEV_URL;#build-system-term'>OpenEmbedded Build System</ulink>.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:
</emphasis>
A virtual machine that
enables you to build and boot a custom embedded Linux image
with the Yocto Project using a non-Linux development system.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:
</emphasis>
The bug tracking application the Yocto Project uses.
If you find problems with the Yocto Project, you should report
them using this application.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla Configuration and Bug Tracking Wiki Page</ulink>:
</emphasis>
Information on how to get set up and use the Yocto Project
implementation of Bugzilla for logging and tracking Yocto
Project defects.
</para></listitem>
<listitem><para>
<emphasis>Internet Relay Chat (IRC):</emphasis>
Two IRC channels on freenode are available
for Yocto Project and Poky discussions: <filename>#yocto</filename> and
<filename>#poky</filename>, respectively.
</para></listitem>
<listitem><para>
<emphasis>
<ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:
</emphasis>
An open-source machine emulator and virtualizer.
</para></listitem>
</itemizedlist>
For more links, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#other-information'>Other Information</ulink>"
section in the Yocto Project Development Manual.
</para>
</section>
<section id='resources-contributions'>
<title>Contributions</title>
<para>
The Yocto Project gladly accepts contributions.
You can submit changes to the project either by creating and sending
pull requests,
or by submitting patches through email.
For information on how to do both as well as information on how
to identify the maintainer for each area of code, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>"
section in the Yocto Project Development Manual.
</para>
</section>
</chapter>
<!--
vim: expandtab tw=80 ts=4