xref: /OK3568_Linux_fs/yocto/poky/documentation/ref-manual/resources.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
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. There is a number of places where you can 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:`dev-manual/common-tasks:submitting a change to the yocto project`" 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
46For a general procedure and guidelines on how to use Bugzilla to submit a bug
47against the Yocto Project, see the following:
48
49-  The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`"
50   section in the Yocto Project Development Tasks Manual.
51
52-  The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
53
54For information on Bugzilla in general, see https://www.bugzilla.org/about/.
55
56.. _resources-mailinglist:
57
58Mailing lists
59=============
60
61There are multiple mailing lists maintained by the Yocto Project as well
62as related OpenEmbedded mailing lists for discussion, patch submission
63and announcements. To subscribe to one of the following mailing lists,
64click on the appropriate URL in the following list and follow the
65instructions:
66
67-  :yocto_lists:`/g/yocto` - General Yocto Project
68   discussion mailing list.
69
70-  :oe_lists:`/g/openembedded-core` - Discussion mailing
71   list about OpenEmbedded-Core (the core metadata).
72
73-  :oe_lists:`/g/openembedded-devel` - Discussion
74   mailing list about OpenEmbedded.
75
76-  :oe_lists:`/g/bitbake-devel` - Discussion mailing
77   list about the :term:`BitBake` build tool.
78
79-  :yocto_lists:`/g/poky` - Discussion mailing list
80   about :term:`Poky`.
81
82-  :yocto_lists:`/g/yocto-announce` - Mailing list to
83   receive official Yocto Project release and milestone announcements.
84
85For more Yocto Project-related mailing lists, see the
86:yocto_home:`Yocto Project Website <>`.
87
88.. _resources-irc:
89
90Internet Relay Chat (IRC)
91=========================
92
93Two IRC channels on `Libera Chat <https://libera.chat/>`__
94are available for the Yocto Project and OpenEmbedded discussions:
95
96-  ``#yocto``
97
98-  ``#oe``
99
100.. _resources-links-and-related-documentation:
101
102Links and Related Documentation
103===============================
104
105Here is a list of resources you might find helpful:
106
107-  :yocto_home:`The Yocto Project Website <>`\ *:* The home site
108   for the Yocto Project.
109
110-  :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for
111   the Yocto Project. This page contains information about project
112   planning, release engineering, QA & automation, a reference site map,
113   and other resources related to the Yocto Project.
114
115-  :oe_home:`OpenEmbedded <>`\ *:* The build system used by the
116   Yocto Project. This project is the upstream, generic, embedded
117   distribution from which the Yocto Project derives its build system
118   (Poky) and to which it contributes.
119
120-  :oe_wiki:`BitBake </BitBake>`\ *:* The tool used to process metadata.
121
122-  :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
123   guide to the BitBake tool. If you want information on BitBake, see
124   this manual.
125
126-  :doc:`/brief-yoctoprojectqs/index` *:* This
127   short document lets you experience building an image using the Yocto
128   Project without having to understand any concepts or details.
129
130-  :doc:`/overview-manual/index` *:* This manual provides overview
131   and conceptual information about the Yocto Project.
132
133-  :doc:`/dev-manual/index` *:* This manual is a "how-to" guide
134   that presents procedures useful to both application and system
135   developers who use the Yocto Project.
136
137-  :doc:`/sdk-manual/index` *manual :* This
138   guide provides information that lets you get going with the standard
139   or extensible SDK. An SDK, with its cross-development toolchains,
140   allows you to develop projects inside or outside of the Yocto Project
141   environment.
142
143-  :doc:`/bsp-guide/bsp` *:* This guide defines the structure
144   for BSP components. Having a commonly understood structure encourages
145   standardization.
146
147-  :doc:`/kernel-dev/index` *:* This manual describes
148   how to work with Linux Yocto kernels as well as provides a bit of
149   conceptual information on the construction of the Yocto Linux kernel
150   tree.
151
152-  :doc:`/ref-manual/index` *:* This
153   manual provides reference material such as variable, task, and class
154   descriptions.
155
156-  :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`\ *:* This manual
157   is simply a single HTML file comprised of the bulk of the Yocto
158   Project manuals. It makes it easy to search for phrases and terms used
159   in the Yocto Project documentation set.
160
161-  :doc:`/profile-manual/index` *:* This manual presents a set of
162   common and generally useful tracing and profiling schemes along with
163   their applications (as appropriate) to each tool.
164
165-  :doc:`/toaster-manual/index` *:* This manual
166   introduces and describes how to set up and use Toaster. Toaster is an
167   Application Programming Interface (API) and web-based interface to
168   the :term:`OpenEmbedded Build System`, which uses
169   BitBake, that reports build information.
170
171-  :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked
172   questions and their answers.
173
174-  *Release Notes:* Features, updates and known issues for the current
175   release of the Yocto Project. To access the Release Notes, go to the
176   :yocto_home:`Downloads </software-overview/downloads>` page on
177   the Yocto Project website and click on the "RELEASE INFORMATION" link
178   for the appropriate release.
179
180-  :yocto_bugs:`Bugzilla <>`\ *:* The bug tracking application
181   the Yocto Project uses. If you find problems with the Yocto Project,
182   you should report them using this application.
183
184-  :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page
185   </Bugzilla_Configuration_and_Bug_Tracking>`\ *:*
186   Information on how to get set up and use the Yocto Project
187   implementation of Bugzilla for logging and tracking Yocto Project
188   defects.
189
190-  *Internet Relay Chat (IRC):* Two IRC channels on
191   `Libera Chat <https://libera.chat/>`__ are
192   available for Yocto Project and OpenEmbeddded discussions: ``#yocto`` and
193   ``#oe``, respectively.
194
195-  `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__\ *:* An
196   open-source machine emulator and virtualizer.
197