summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-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/overview-manual/overview-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/overview-manual/overview-manual-intro.rst')
-rw-r--r--documentation/overview-manual/overview-manual-intro.rst74
1 files changed, 74 insertions, 0 deletions
diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst
new file mode 100644
index 0000000000..3f206fd54b
--- /dev/null
+++ b/documentation/overview-manual/overview-manual-intro.rst
@@ -0,0 +1,74 @@
1.. SPDX-License-Identifier: CC-BY-2.0-UK
2
3**********************************************
4The Yocto Project Overview and Concepts Manual
5**********************************************
6
7.. _overview-manual-welcome:
8
9Welcome
10=======
11
12Welcome to the Yocto Project Overview and Concepts Manual! This manual
13introduces the Yocto Project by providing concepts, software overviews,
14best-known-methods (BKMs), and any other high-level introductory
15information suitable for a new Yocto Project user.
16
17The following list describes what you can get from this manual:
18
19- `Introducing the Yocto Project <#overview-yp>`__\ *:* This chapter
20 provides an introduction to the Yocto Project. You will learn about
21 features and challenges of the Yocto Project, the layer model,
22 components and tools, development methods, the
23 :term:`Poky` reference distribution, the
24 OpenEmbedded build system workflow, and some basic Yocto terms.
25
26- `The Yocto Project Development
27 Environment <#overview-development-environment>`__\ *:* This chapter
28 helps you get started understanding the Yocto Project development
29 environment. You will learn about open source, development hosts,
30 Yocto Project source repositories, workflows using Git and the Yocto
31 Project, a Git primer, and information about licensing.
32
33- :doc:`overview-manual-concepts` *:* This
34 chapter presents various concepts regarding the Yocto Project. You
35 can find conceptual information about components, development,
36 cross-toolchains, and so forth.
37
38This manual does not give you the following:
39
40- *Step-by-step Instructions for Development Tasks:* Instructional
41 procedures reside in other manuals within the Yocto Project
42 documentation set. For example, the :doc:`../dev-manual/dev-manual`
43 provides examples on how to perform
44 various development tasks. As another example, the
45 :doc:`../sdk-manual/sdk-manual` manual contains detailed
46 instructions on how to install an SDK, which is used to develop
47 applications for target hardware.
48
49- *Reference Material:* This type of material resides in an appropriate
50 reference manual. For example, system variables are documented in the
51 :doc:`../ref-manual/ref-manual`. As another
52 example, the :doc:`../bsp-guide/bsp-guide` contains reference information on
53 BSPs.
54
55- *Detailed Public Information Not Specific to the Yocto Project:* For
56 example, exhaustive information on how to use the Source Control
57 Manager Git is better covered with Internet searches and official Git
58 Documentation than through the Yocto Project documentation.
59
60.. _overview-manual-other-information:
61
62Other Information
63=================
64
65Because this manual presents information for many different topics,
66supplemental information is recommended for full comprehension. For
67additional introductory information on the Yocto Project, see the
68:yocto_home:`Yocto Project Website <>`. If you want to build an image
69with no knowledge of Yocto Project as a way of quickly testing it out,
70see the :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document.
71For a comprehensive list of links and other documentation, see the
72":ref:`Links and Related
73Documentation <resources-links-and-related-documentation>`"
74section in the Yocto Project Reference Manual.