summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/resources.xml
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-10-05 16:30:32 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-10-06 13:56:17 +0100
commit43d07a285181e64c30d98d10ff93ef50391efe59 (patch)
tree78918fc94d55d44d35e1e3e61c7a6fccc28bca24 /documentation/ref-manual/resources.xml
parent1fd9c4b2c0ae927df29f7a0d34c3e595bcf48e89 (diff)
downloadpoky-43d07a285181e64c30d98d10ff93ef50391efe59.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: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/resources.xml')
-rw-r--r--documentation/ref-manual/resources.xml298
1 files changed, 0 insertions, 298 deletions
diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml
deleted file mode 100644
index 4899b2e599..0000000000
--- a/documentation/ref-manual/resources.xml
+++ /dev/null
@@ -1,298 +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='resources'>
7<title>Contributions and Additional Information</title>
8
9<section id='resources-intro'>
10 <title>Introduction</title>
11 <para>
12 The Yocto Project team is happy for people to experiment with the
13 Yocto Project.
14 A number of places exist to find help if you run into difficulties
15 or find bugs.
16 This presents information about contributing and participating in
17 the Yocto Project.
18 </para>
19</section>
20
21<section id='resources-contributions'>
22 <title>Contributions</title>
23
24 <para>
25 The Yocto Project gladly accepts contributions.
26 You can submit changes to the project either by creating and sending
27 pull requests,
28 or by submitting patches through email.
29 For information on how to do both as well as information on how
30 to identify the maintainer for each area of code, see the
31 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>"
32 section in the Yocto Project Development Tasks Manual.
33 </para>
34</section>
35
36<section id='resources-bugtracker'>
37 <title>Yocto Project Bugzilla</title>
38
39 <para>
40 The Yocto Project uses its own implementation of
41 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink> to
42 track defects (bugs).
43 Implementations of Bugzilla work well for group development because
44 they track bugs and code changes, can be used to communicate changes
45 and problems with developers, can be used to submit and review patches,
46 and can be used to manage quality assurance.
47 </para>
48
49 <para>
50 Sometimes it is helpful to submit, investigate, or track a bug against
51 the Yocto Project itself (e.g. when discovering an issue with some
52 component of the build system that acts contrary to the documentation
53 or your expectations).
54 </para>
55
56 <para>
57 A general procedure and guidelines exist for when you use Bugzilla to
58 submit a bug.
59 For information on how to use Bugzilla to submit a bug against the
60 Yocto Project, see the following:
61 <itemizedlist>
62 <listitem><para>
63 The
64 "<ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project'>Submitting a Defect Against the Yocto Project</ulink>"
65 section in the Yocto Project Development Tasks Manual.
66 </para></listitem>
67 <listitem><para>
68 The Yocto Project
69 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla wiki page</ulink>
70 </para></listitem>
71 </itemizedlist>
72 For information on Bugzilla in general, see
73 <ulink url='http://www.bugzilla.org/about/'></ulink>.
74 </para>
75</section>
76
77<section id='resources-mailinglist'>
78 <title>Mailing lists</title>
79
80 <para>
81 A number of mailing lists maintained by the Yocto Project exist
82 as well as related OpenEmbedded mailing lists for discussion,
83 patch submission and announcements.
84 To subscribe to one of the following mailing lists, click on the
85 appropriate URL in the following list and follow the instructions:
86 <itemizedlist>
87 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> -
88 General Yocto Project discussion mailing list. </para></listitem>
89 <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'></ulink> -
90 Discussion mailing list about OpenEmbedded-Core (the core metadata).</para></listitem>
91 <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-devel'></ulink> -
92 Discussion mailing list about OpenEmbedded.</para></listitem>
93 <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/bitbake-devel'></ulink> -
94 Discussion mailing list about the
95 <link linkend='bitbake-term'>BitBake</link>
96 build tool.</para></listitem>
97 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> -
98 Discussion mailing list about
99 <link linkend='poky'>Poky</link>.
100 </para></listitem>
101 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> -
102 Mailing list to receive official Yocto Project release and milestone
103 announcements.</para></listitem>
104 </itemizedlist>
105 </para>
106 For more Yocto Project-related mailing lists, see the
107 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
108</section>
109
110<section id='resources-irc'>
111 <title>Internet Relay Chat (IRC)</title>
112
113 <para>
114 Two IRC channels on freenode are available for the Yocto Project and Poky discussions:
115 <itemizedlist>
116 <listitem><para><filename>#yocto</filename></para></listitem>
117 <listitem><para><filename>#poky</filename></para></listitem>
118 </itemizedlist>
119 </para>
120</section>
121
122<section id='resources-links-and-related-documentation'>
123 <title>Links and Related Documentation</title>
124
125 <para>
126 Here is a list of resources you might find helpful:
127 <itemizedlist>
128 <listitem><para>
129 <emphasis>
130 <ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>:
131 </emphasis> The home site for the Yocto Project.
132 </para></listitem>
133 <listitem><para>
134 <emphasis>
135 <ulink url='&YOCTO_WIKI_URL;/wiki/Main_Page'>The Yocto Project Main Wiki Page</ulink>:
136 </emphasis>
137 The main wiki page for the Yocto Project.
138 This page contains information about project planning,
139 release engineering, QA &amp; automation, a reference
140 site map, and other resources related to the Yocto Project.
141 </para></listitem>
142 <listitem><para>
143 <emphasis>
144 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:
145 </emphasis>
146 The build system used by the Yocto Project.
147 This project is the upstream, generic, embedded distribution
148 from which the Yocto Project derives its build system (Poky)
149 and to which it contributes.
150 </para></listitem>
151 <listitem><para>
152 <emphasis>
153 <ulink url='http://www.openembedded.org/wiki/BitBake'>
154 BitBake</ulink>:
155 </emphasis> The tool used to process metadata.
156 </para></listitem>
157 <listitem><para>
158 <emphasis>
159 <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>:
160 </emphasis>
161 A comprehensive guide to the BitBake tool.
162 If you want information on BitBake, see this manual.
163 </para></listitem>
164 <listitem><para>
165 <emphasis>
166 <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>:
167 </emphasis>
168 This short document lets you experience building an image using
169 the Yocto Project without having to understand any concepts or
170 details.
171 </para></listitem>
172 <listitem><para>
173 <emphasis>
174 <ulink url='&YOCTO_DOCS_OM_URL;'>Yocto Project Overview and Concepts Manual</ulink>:
175 </emphasis>
176 This manual provides overview and conceptual information
177 about the Yocto Project.
178 </para></listitem>
179 <listitem><para>
180 <emphasis>
181 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>:
182 </emphasis>
183 This manual is a "how-to" guide that presents procedures
184 useful to both application and system developers who use the
185 Yocto Project.
186 </para></listitem>
187 <listitem><para>
188 <emphasis>
189 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
190 manual:</emphasis>
191 This guide provides information that lets you get going
192 with the standard or extensible SDK.
193 An SDK, with its cross-development toolchains, allows you
194 to develop projects inside or outside of the Yocto Project
195 environment.
196 </para></listitem>
197 <listitem><para>
198 <emphasis>
199 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:
200 </emphasis>
201 This guide defines the structure for BSP components.
202 Having a commonly understood structure encourages
203 standardization.
204 </para></listitem>
205 <listitem><para>
206 <emphasis>
207 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:
208 </emphasis>
209 This manual describes how to work with Linux Yocto kernels as
210 well as provides a bit of conceptual information on the
211 construction of the Yocto Linux kernel tree.
212 </para></listitem>
213 <listitem><para>
214 <emphasis>
215 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:
216 </emphasis>
217 This manual provides reference material such as variable,
218 task, and class descriptions.
219 </para></listitem>
220 <listitem><para>
221 <emphasis>
222 <ulink url='&YOCTO_DOCS_MM_URL;'>Yocto Project Mega-Manual</ulink>:
223 </emphasis>
224 This manual is simply a single HTML file comprised of the
225 bulk of the Yocto Project manuals.
226 The Mega-Manual primarily exists as a vehicle by which you can
227 easily search for phrases and terms used in the Yocto Project
228 documentation set.
229 </para></listitem>
230 <listitem><para>
231 <emphasis>
232 <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:
233 </emphasis>
234 This manual presents a set of common and generally useful
235 tracing and profiling schemes along with their applications
236 (as appropriate) to each tool.
237 </para></listitem>
238 <listitem><para>
239 <emphasis>
240 <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>:
241 </emphasis>
242 This manual introduces and describes how to set up and use
243 Toaster.
244 Toaster is an Application Programming Interface (API) and
245 web-based interface to the
246 <link linkend='build-system-term'>OpenEmbedded Build System</link>,
247 which uses BitBake, that reports build information.
248 </para></listitem>
249 <listitem><para>
250 <emphasis>
251 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:
252 </emphasis>
253 A list of commonly asked questions and their answers.
254 </para></listitem>
255 <listitem><para>
256 <emphasis>Release Notes:</emphasis>
257 Features, updates and known issues for the current
258 release of the Yocto Project.
259 To access the Release Notes, go to the
260 <ulink url='&YOCTO_HOME_URL;/software-overview/downloads/'>Downloads</ulink>
261 page on the Yocto Project website and click on the
262 "RELEASE INFORMATION" link for the appropriate release.
263 </para></listitem>
264 <listitem><para>
265 <emphasis>
266 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:
267 </emphasis>
268 The bug tracking application the Yocto Project uses.
269 If you find problems with the Yocto Project, you should report
270 them using this application.
271 </para></listitem>
272 <listitem><para>
273 <emphasis>
274 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla Configuration and Bug Tracking Wiki Page</ulink>:
275 </emphasis>
276 Information on how to get set up and use the Yocto Project
277 implementation of Bugzilla for logging and tracking Yocto
278 Project defects.
279 </para></listitem>
280 <listitem><para>
281 <emphasis>Internet Relay Chat (IRC):</emphasis>
282 Two IRC channels on freenode are available
283 for Yocto Project and Poky discussions: <filename>#yocto</filename> and
284 <filename>#poky</filename>, respectively.
285 </para></listitem>
286 <listitem><para>
287 <emphasis>
288 <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:
289 </emphasis>
290 An open-source machine emulator and virtualizer.
291 </para></listitem>
292 </itemizedlist>
293 </para>
294</section>
295</chapter>
296<!--
297vim: expandtab tw=80 ts=4
298-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-10-11 18:28:46 +0000