mirror of
https://git.yoctoproject.org/poky
synced 2026-07-16 03:47:03 +00:00
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
committed by
Richard Purdie
Richard Purdie
parent
741dddf11a
commit
ed0ecc7b76
@@ -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 & 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
|
||||
|
||||
Reference in New Issue
Block a user