blob: f90182b9e322d29ecd98b2229a5bfb324c7fd220 [file] [log] [blame]
Andrew Geissleraf5e4ef2020-10-16 10:22:50 -05001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002
3****************************************
4Contributions and Additional Information
5****************************************
6
7.. _resources-intro:
8
9Introduction
10============
11
12The Yocto Project team is happy for people to experiment with the Yocto
13Project. A number of places exist to find help if you run into
14difficulties or find bugs. This presents information about contributing
15and participating in the Yocto Project.
16
17.. _resources-contributions:
18
19Contributions
20=============
21
22The Yocto Project gladly accepts contributions. You can submit changes
23to the project either by creating and sending pull requests, or by
24submitting patches through email. For information on how to do both as
25well as information on how to identify the maintainer for each area of
26code, see the ":ref:`how-to-submit-a-change`" section in the
27Yocto Project Development Tasks Manual.
28
29.. _resources-bugtracker:
30
31Yocto Project Bugzilla
32======================
33
34The Yocto Project uses its own implementation of
35:yocto_bugs:`Bugzilla <>` to track defects (bugs).
36Implementations of Bugzilla work well for group development because they
37track bugs and code changes, can be used to communicate changes and
38problems with developers, can be used to submit and review patches, and
39can be used to manage quality assurance.
40
41Sometimes it is helpful to submit, investigate, or track a bug against
42the Yocto Project itself (e.g. when discovering an issue with some
43component of the build system that acts contrary to the documentation or
44your expectations).
45
46A general procedure and guidelines exist for when you use Bugzilla to
47submit a bug. For information on how to use Bugzilla to submit a bug
48against the Yocto Project, see the following:
49
50- The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`"
51 section in the Yocto Project Development Tasks Manual.
52
53- The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
54
55For information on Bugzilla in general, see http://www.bugzilla.org/about/.
56
57.. _resources-mailinglist:
58
59Mailing lists
60=============
61
62A number of mailing lists maintained by the Yocto Project exist as well
63as related OpenEmbedded mailing lists for discussion, patch submission
64and announcements. To subscribe to one of the following mailing lists,
65click on the appropriate URL in the following list and follow the
66instructions:
67
68- https://lists.yoctoproject.org/g/yocto - General Yocto Project
69 discussion mailing list.
70
71- https://lists.openembedded.org/g/openembedded-core - Discussion mailing
72 list about OpenEmbedded-Core (the core metadata).
73
74- https://lists.openembedded.org/g/openembedded-devel - Discussion
75 mailing list about OpenEmbedded.
76
77- https://lists.openembedded.org/g/bitbake-devel - Discussion mailing
78 list about the :term:`BitBake` build tool.
79
80- https://lists.yoctoproject.org/g/poky - Discussion mailing list
81 about `Poky <#poky>`__.
82
83- https://lists.yoctoproject.org/g/yocto-announce - Mailing list to
84 receive official Yocto Project release and milestone announcements.
85
86For more Yocto Project-related mailing lists, see the
87Yocto Project Website
88.
89.. _resources-irc:
90
91Internet Relay Chat (IRC)
92=========================
93
94Two IRC channels on freenode are available for the Yocto Project and
95Poky discussions:
96
97- ``#yocto``
98
99- ``#poky``
100
101.. _resources-links-and-related-documentation:
102
103Links and Related Documentation
104===============================
105
106Here is a list of resources you might find helpful:
107
108- :yocto_home:`The Yocto Project Website <>`\ *:* The home site
109 for the Yocto Project.
110
111- :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for
112 the Yocto Project. This page contains information about project
113 planning, release engineering, QA & automation, a reference site map,
114 and other resources related to the Yocto Project.
115
116- `OpenEmbedded <http://www.openembedded.org/>`__\ *:* The build system used by the
117 Yocto Project. This project is the upstream, generic, embedded
118 distribution from which the Yocto Project derives its build system
119 (Poky) and to which it contributes.
120
121- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool
122 used to process metadata.
123
124- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
125 guide to the BitBake tool. If you want information on BitBake, see
126 this manual.
127
128- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` *:* This
129 short document lets you experience building an image using the Yocto
130 Project without having to understand any concepts or details.
131
132- :doc:`../overview-manual/overview-manual` *:* This manual provides overview
133 and conceptual information about the Yocto Project.
134
135- :doc:`../dev-manual/dev-manual` *:* This manual is a "how-to" guide
136 that presents procedures useful to both application and system
137 developers who use the Yocto Project.
138
139- :doc:`../sdk-manual/sdk-manual` *manual :* This
140 guide provides information that lets you get going with the standard
141 or extensible SDK. An SDK, with its cross-development toolchains,
142 allows you to develop projects inside or outside of the Yocto Project
143 environment.
144
145- :doc:`../bsp-guide/bsp` *:* This guide defines the structure
146 for BSP components. Having a commonly understood structure encourages
147 standardization.
148
149- :doc:`../kernel-dev/kernel-dev` *:* This manual describes
150 how to work with Linux Yocto kernels as well as provides a bit of
151 conceptual information on the construction of the Yocto Linux kernel
152 tree.
153
154- :doc:`../ref-manual/ref-manual` *:* This
155 manual provides reference material such as variable, task, and class
156 descriptions.
157
158- `Yocto Project Mega-Manual <https://docs.yoctoproject.org/singleindex.html>`__\ *:* This manual
159 is simply a single HTML file comprised of the bulk of the Yocto
160 Project manuals. The Mega-Manual primarily exists as a vehicle by
161 which you can easily search for phrases and terms used in the Yocto
162 Project documentation set.
163
164- :doc:`../profile-manual/profile-manual` *:* This manual presents a set of
165 common and generally useful tracing and profiling schemes along with
166 their applications (as appropriate) to each tool.
167
168- :doc:`../toaster-manual/toaster-manual` *:* This manual
169 introduces and describes how to set up and use Toaster. Toaster is an
170 Application Programming Interface (API) and web-based interface to
171 the :term:`OpenEmbedded Build System`, which uses
172 BitBake, that reports build information.
173
174- :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked
175 questions and their answers.
176
177- *Release Notes:* Features, updates and known issues for the current
178 release of the Yocto Project. To access the Release Notes, go to the
179 :yocto_home:`Downloads </software-overview/downloads>` page on
180 the Yocto Project website and click on the "RELEASE INFORMATION" link
181 for the appropriate release.
182
183- `Bugzilla <https://bugzilla.yoctoproject.org>`__\ *:* The bug tracking application
184 the Yocto Project uses. If you find problems with the Yocto Project,
185 you should report them using this application.
186
187- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:*
188 Information on how to get set up and use the Yocto Project
189 implementation of Bugzilla for logging and tracking Yocto Project
190 defects.
191
192- *Internet Relay Chat (IRC):* Two IRC channels on freenode are
193 available for Yocto Project and Poky discussions: ``#yocto`` and
194 ``#poky``, respectively.
195
196- `Quick EMUlator (QEMU) <http://wiki.qemu.org/Index.html>`__\ *:* An
197 open-source machine emulator and virtualizer.