mirror of
https://git.yoctoproject.org/poky
synced 2026-03-19 13:49:41 +01:00
fa0cb4d34b
The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
105 lines
4.5 KiB
XML
105 lines
4.5 KiB
XML
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
|
|
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
|
|
|
|
<chapter id='dev-manual-intro'>
|
|
|
|
<title>The Yocto Project Development Tasks Manual</title>
|
|
<section id='dev-welcome'>
|
|
<title>Welcome</title>
|
|
|
|
<para>
|
|
Welcome to the Yocto Project Development Tasks Manual!
|
|
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).
|
|
The manual groups related procedures into higher-level sections.
|
|
Procedures can consist of high-level steps or low-level steps
|
|
depending on the topic.
|
|
</para>
|
|
|
|
<para>
|
|
This manual provides the following:
|
|
<itemizedlist>
|
|
<listitem><para>
|
|
Procedures that help you get going with the Yocto Project.
|
|
For example, procedures that show you how to set up
|
|
a build host and work with the Yocto Project
|
|
source repositories.
|
|
</para></listitem>
|
|
<listitem><para>
|
|
Procedures that show you how to submit changes to the
|
|
Yocto Project.
|
|
Changes can be improvements, new features, or bug
|
|
fixes.
|
|
</para></listitem>
|
|
<listitem><para>
|
|
Procedures related to "everyday" tasks you perform while
|
|
developing images and applications using the Yocto
|
|
Project.
|
|
For example, procedures to create a layer, customize an
|
|
image, write a new recipe, and so forth.
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
|
|
<para>
|
|
This manual does not provide the following:
|
|
<itemizedlist>
|
|
<listitem><para>
|
|
Redundant Step-by-step Instructions:
|
|
For example, the
|
|
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
|
|
manual contains detailed instructions on how to install an
|
|
SDK, which is used to develop applications for target
|
|
hardware.
|
|
</para></listitem>
|
|
<listitem><para>
|
|
Reference or Conceptual Material:
|
|
This type of material resides in an appropriate reference
|
|
manual.
|
|
For example, system variables are documented in the
|
|
<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.
|
|
</para></listitem>
|
|
<listitem><para>
|
|
Detailed Public Information Not Specific to the
|
|
Yocto Project:
|
|
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.
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='other-information'>
|
|
<title>Other Information</title>
|
|
|
|
<para>
|
|
Because this manual presents information for many different
|
|
topics, supplemental information is recommended for full
|
|
comprehension.
|
|
For introductory information on the Yocto Project, see the
|
|
<ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
|
|
If you want to build an image with no knowledge of Yocto Project
|
|
as a way of quickly testing it out, see the
|
|
<ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
|
|
document.
|
|
</para>
|
|
|
|
<para>
|
|
For a comprehensive list of links and other documentation, 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.
|
|
</para>
|
|
|
|
<para>
|
|
</para>
|
|
</section>
|
|
</chapter>
|
|
<!--
|
|
vim: expandtab tw=80 ts=4
|
|
-->
|