diff options
| author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-10-05 16:30:32 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:01 +0000 |
| commit | b175f353436eb7411ba3d5010fd8588652393982 (patch) | |
| tree | e7a4d5215f53a9042698ec7be24a37717fc1d78f /documentation/dev-manual/dev-manual-intro.xml | |
| parent | a934ad95cfafba4219732fa6c5c40a2d16220f23 (diff) | |
| download | poky-b175f353436eb7411ba3d5010fd8588652393982.tar.gz | |
sphinx: remove DocBook files
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: abdb6b6bdfef3dc8e8cc13779e44a8d6df903469)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(cherry picked from commit 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
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.xml')
| -rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 104 |
1 files changed, 0 insertions, 104 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml deleted file mode 100644 index 38de5e4f53..0000000000 --- a/documentation/dev-manual/dev-manual-intro.xml +++ /dev/null | |||
| @@ -1,104 +0,0 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | <!--SPDX-License-Identifier: CC-BY-2.0-UK--> | ||
| 5 | |||
| 6 | <chapter id='dev-manual-intro'> | ||
| 7 | |||
| 8 | <title>The Yocto Project Development Tasks Manual</title> | ||
| 9 | <section id='dev-welcome'> | ||
| 10 | <title>Welcome</title> | ||
| 11 | |||
| 12 | <para> | ||
| 13 | Welcome to the Yocto Project Development Tasks Manual! | ||
| 14 | This manual provides relevant procedures necessary for developing | ||
| 15 | in the Yocto Project environment (i.e. developing embedded Linux | ||
| 16 | images and user-space applications that run on targeted devices). | ||
| 17 | The manual groups related procedures into higher-level sections. | ||
| 18 | Procedures can consist of high-level steps or low-level steps | ||
| 19 | depending on the topic. | ||
| 20 | </para> | ||
| 21 | |||
| 22 | <para> | ||
| 23 | This manual provides the following: | ||
| 24 | <itemizedlist> | ||
| 25 | <listitem><para> | ||
| 26 | Procedures that help you get going with the Yocto Project. | ||
| 27 | For example, procedures that show you how to set up | ||
| 28 | a build host and work with the Yocto Project | ||
| 29 | source repositories. | ||
| 30 | </para></listitem> | ||
| 31 | <listitem><para> | ||
| 32 | Procedures that show you how to submit changes to the | ||
| 33 | Yocto Project. | ||
| 34 | Changes can be improvements, new features, or bug | ||
| 35 | fixes. | ||
| 36 | </para></listitem> | ||
| 37 | <listitem><para> | ||
| 38 | Procedures related to "everyday" tasks you perform while | ||
| 39 | developing images and applications using the Yocto | ||
| 40 | Project. | ||
| 41 | For example, procedures to create a layer, customize an | ||
| 42 | image, write a new recipe, and so forth. | ||
| 43 | </para></listitem> | ||
| 44 | </itemizedlist> | ||
| 45 | </para> | ||
| 46 | |||
| 47 | <para> | ||
| 48 | This manual does not provide the following: | ||
| 49 | <itemizedlist> | ||
| 50 | <listitem><para> | ||
| 51 | Redundant Step-by-step Instructions: | ||
| 52 | For example, the | ||
| 53 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> | ||
| 54 | manual contains detailed instructions on how to install an | ||
| 55 | SDK, which is used to develop applications for target | ||
| 56 | hardware. | ||
| 57 | </para></listitem> | ||
| 58 | <listitem><para> | ||
| 59 | Reference or Conceptual Material: | ||
| 60 | This type of material resides in an appropriate reference | ||
| 61 | manual. | ||
| 62 | For example, system variables are documented in the | ||
| 63 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>. | ||
| 64 | </para></listitem> | ||
| 65 | <listitem><para> | ||
| 66 | Detailed Public Information Not Specific to the | ||
| 67 | Yocto Project: | ||
| 68 | For example, exhaustive information on how to use the | ||
| 69 | Source Control Manager Git is better covered with Internet | ||
| 70 | searches and official Git Documentation than through the | ||
| 71 | Yocto Project documentation. | ||
| 72 | </para></listitem> | ||
| 73 | </itemizedlist> | ||
| 74 | </para> | ||
| 75 | </section> | ||
| 76 | |||
| 77 | <section id='other-information'> | ||
| 78 | <title>Other Information</title> | ||
| 79 | |||
| 80 | <para> | ||
| 81 | Because this manual presents information for many different | ||
| 82 | topics, supplemental information is recommended for full | ||
| 83 | comprehension. | ||
| 84 | For introductory information on the Yocto Project, see the | ||
| 85 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | ||
| 86 | If you want to build an image with no knowledge of Yocto Project | ||
| 87 | as a way of quickly testing it out, see the | ||
| 88 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> | ||
| 89 | document. | ||
| 90 | </para> | ||
| 91 | |||
| 92 | <para> | ||
| 93 | For a comprehensive list of links and other documentation, see the | ||
| 94 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>" | ||
| 95 | section in the Yocto Project Reference Manual. | ||
| 96 | </para> | ||
| 97 | |||
| 98 | <para> | ||
| 99 | </para> | ||
| 100 | </section> | ||
| 101 | </chapter> | ||
| 102 | <!-- | ||
| 103 | vim: expandtab tw=80 ts=4 | ||
| 104 | --> | ||
