diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-11-20 20:17:33 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:00 +0000 |
commit | fa0cb4d34b1073f215fa3c680f2316208739d53d (patch) | |
tree | ba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/test-manual/test-manual.xml | |
parent | a038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff) | |
download | poky-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/test-manual/test-manual.xml')
-rwxr-xr-x | documentation/test-manual/test-manual.xml | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/documentation/test-manual/test-manual.xml b/documentation/test-manual/test-manual.xml new file mode 100755 index 0000000000..d454566c5f --- /dev/null +++ b/documentation/test-manual/test-manual.xml | |||
@@ -0,0 +1,104 @@ | |||
1 | <!DOCTYPE book 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 | <book id='test-manual' lang='en' | ||
7 | xmlns:xi="http://www.w3.org/2003/XInclude" | ||
8 | xmlns="http://docbook.org/ns/docbook" | ||
9 | > | ||
10 | <bookinfo> | ||
11 | |||
12 | <mediaobject> | ||
13 | <imageobject> | ||
14 | <imagedata fileref='figures/test-manual-title.png' | ||
15 | format='SVG' | ||
16 | align='left' scalefit='1' width='100%'/> | ||
17 | </imageobject> | ||
18 | </mediaobject> | ||
19 | |||
20 | <title> | ||
21 | Yocto Project Test Environment Manual | ||
22 | </title> | ||
23 | |||
24 | <authorgroup> | ||
25 | <author> | ||
26 | <affiliation> | ||
27 | <orgname>&ORGNAME;</orgname> | ||
28 | </affiliation> | ||
29 | <email>&ORGEMAIL;</email> | ||
30 | </author> | ||
31 | </authorgroup> | ||
32 | |||
33 | <revhistory> | ||
34 | <revision> | ||
35 | <revnumber>3.1.1</revnumber> | ||
36 | <date>TBD</date> | ||
37 | <revremark>DRAFT - Work-in-Progress - posted June 16, 2020</revremark> | ||
38 | </revision> | ||
39 | </revhistory> | ||
40 | |||
41 | <copyright> | ||
42 | <year>©RIGHT_YEAR;</year> | ||
43 | <holder>Linux Foundation</holder> | ||
44 | </copyright> | ||
45 | |||
46 | <legalnotice> | ||
47 | <para> | ||
48 | Permission is granted to copy, distribute and/or modify this document under | ||
49 | the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/"> | ||
50 | Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by | ||
51 | Creative Commons. | ||
52 | </para> | ||
53 | <note><title>Manual Notes</title> | ||
54 | <itemizedlist> | ||
55 | <listitem><para> | ||
56 | This version of the | ||
57 | <emphasis>Yocto Project Test Environment Manual</emphasis> | ||
58 | is for the &YOCTO_DOC_VERSION; release of the | ||
59 | Yocto Project. | ||
60 | To be sure you have the latest version of the manual | ||
61 | for this release, go to the | ||
62 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
63 | and select the manual from that site. | ||
64 | Manuals from the site are more up-to-date than manuals | ||
65 | derived from the Yocto Project released TAR files. | ||
66 | </para></listitem> | ||
67 | <listitem><para> | ||
68 | If you located this manual through a web search, the | ||
69 | version of the manual might not be the one you want | ||
70 | (e.g. the search might have returned a manual much | ||
71 | older than the Yocto Project version with which you | ||
72 | are working). | ||
73 | You can see all Yocto Project major releases by | ||
74 | visiting the | ||
75 | <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> | ||
76 | page. | ||
77 | If you need a version of this manual for a different | ||
78 | Yocto Project release, visit the | ||
79 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
80 | and select the manual set by using the | ||
81 | "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" | ||
82 | pull-down menus. | ||
83 | </para></listitem> | ||
84 | <listitem><para> | ||
85 | To report any inaccuracies or problems with this | ||
86 | manual, send an email to the Yocto Project | ||
87 | discussion group at | ||
88 | <filename>yocto@yoctoproject.com</filename> or log into | ||
89 | the freenode <filename>#yocto</filename> channel. | ||
90 | </para></listitem> | ||
91 | </itemizedlist> | ||
92 | </note> | ||
93 | </legalnotice> | ||
94 | |||
95 | </bookinfo> | ||
96 | |||
97 | <xi:include href="test-manual-intro.xml"/> | ||
98 | <xi:include href="test-manual-test-process.xml"/> | ||
99 | <xi:include href="test-manual-understand-autobuilder.xml"/> | ||
100 | |||
101 | </book> | ||
102 | <!-- | ||
103 | vim: expandtab tw=80 ts=4 | ||
104 | --> | ||