summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-intro.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 20:17:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-04 10:55:00 +0000
commitfa0cb4d34b1073f215fa3c680f2316208739d53d (patch)
treeba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/dev-manual/dev-manual-intro.rst
parenta038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff)
downloadpoky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz
sphinx: import docs
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>
Diffstat (limited to 'documentation/dev-manual/dev-manual-intro.rst')
-rw-r--r--documentation/dev-manual/dev-manual-intro.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst
new file mode 100644
index 0000000000..3225c6ca45
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-intro.rst
@@ -0,0 +1,61 @@
1.. SPDX-License-Identifier: CC-BY-2.0-UK
2
3******************************************
4The Yocto Project Development Tasks Manual
5******************************************
6
7.. _dev-welcome:
8
9Welcome
10=======
11
12Welcome to the Yocto Project Development Tasks Manual! This manual
13provides relevant procedures necessary for developing in the Yocto
14Project environment (i.e. developing embedded Linux images and
15user-space applications that run on targeted devices). The manual groups
16related procedures into higher-level sections. Procedures can consist of
17high-level steps or low-level steps depending on the topic.
18
19This manual provides the following:
20
21- Procedures that help you get going with the Yocto Project. For
22 example, procedures that show you how to set up a build host and work
23 with the Yocto Project source repositories.
24
25- Procedures that show you how to submit changes to the Yocto Project.
26 Changes can be improvements, new features, or bug fixes.
27
28- Procedures related to "everyday" tasks you perform while developing
29 images and applications using the Yocto Project. For example,
30 procedures to create a layer, customize an image, write a new recipe,
31 and so forth.
32
33This manual does not provide the following:
34
35- Redundant Step-by-step Instructions: For example, the
36 :doc:`../sdk-manual/sdk-manual` manual contains detailed
37 instructions on how to install an SDK, which is used to develop
38 applications for target hardware.
39
40- Reference or Conceptual Material: This type of material resides in an
41 appropriate reference manual. For example, system variables are
42 documented in the :doc`../ref-manual/ref-manual`.
43
44- Detailed Public Information Not Specific to the Yocto Project: For
45 example, exhaustive information on how to use the Source Control
46 Manager Git is better covered with Internet searches and official Git
47 Documentation than through the Yocto Project documentation.
48
49Other Information
50=================
51
52Because this manual presents information for many different topics,
53supplemental information is recommended for full comprehension. For
54introductory information on the Yocto Project, see the
55:yocto_home:`Yocto Project Website <>`. If you want to build an image with no
56knowledge of Yocto Project as a way of quickly testing it out, see the
57:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document.
58
59For a comprehensive list of links and other documentation, see the
60":ref:`ref-manual/resources:links and related documentation`"
61section in the Yocto Project Reference Manual.