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