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