blob: 77c36780951cc9f3fb036659f77066b8aeb472ad [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. 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
Andrew Geissler09209ee2020-12-13 08:44:15 -060026code, see the ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the
Andrew Geisslerc9f78652020-09-18 14:11:35 -050027Yocto 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
Andrew Geissler09209ee2020-12-13 08:44:15 -060050- The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -050051 section in the Yocto Project Development Tasks Manual.
52
Andrew Geissler09209ee2020-12-13 08:44:15 -060053- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
Andrew Geisslerc9f78652020-09-18 14:11:35 -050054
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
Andrew Geissler4c19ea12020-10-27 13:52:24 -050068- :yocto_lists:`/g/yocto` - General Yocto Project
Andrew Geisslerc9f78652020-09-18 14:11:35 -050069 discussion mailing list.
70
Andrew Geissler4c19ea12020-10-27 13:52:24 -050071- :oe_lists:`/g/openembedded-core` - Discussion mailing
Andrew Geisslerc9f78652020-09-18 14:11:35 -050072 list about OpenEmbedded-Core (the core metadata).
73
Andrew Geissler4c19ea12020-10-27 13:52:24 -050074- :oe_lists:`/g/openembedded-devel` - Discussion
Andrew Geisslerc9f78652020-09-18 14:11:35 -050075 mailing list about OpenEmbedded.
76
Andrew Geissler4c19ea12020-10-27 13:52:24 -050077- :oe_lists:`/g/bitbake-devel` - Discussion mailing
Andrew Geisslerc9f78652020-09-18 14:11:35 -050078 list about the :term:`BitBake` build tool.
79
Andrew Geissler4c19ea12020-10-27 13:52:24 -050080- :yocto_lists:`/g/poky` - Discussion mailing list
81 about :term:`Poky`.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050082
Andrew Geissler4c19ea12020-10-27 13:52:24 -050083- :yocto_lists:`/g/yocto-announce` - Mailing list to
Andrew Geisslerc9f78652020-09-18 14:11:35 -050084 receive official Yocto Project release and milestone announcements.
85
86For more Yocto Project-related mailing lists, see the
Andrew Geissler4c19ea12020-10-27 13:52:24 -050087:yocto_home:`Yocto Project Website <>`.
88
Andrew Geisslerc9f78652020-09-18 14:11:35 -050089.. _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
Andrew Geissler09209ee2020-12-13 08:44:15 -0600111- :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500112 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
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500116- :oe_home:`OpenEmbedded <>`\ *:* The build system used by the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500117 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
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500121- :oe_home:`BitBake </wiki/BitBake>`\ *:* The tool
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500122 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
Andrew Geissler09209ee2020-12-13 08:44:15 -0600128- :doc:`/brief-yoctoprojectqs/index` *:* This
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500129 short document lets you experience building an image using the Yocto
130 Project without having to understand any concepts or details.
131
Andrew Geissler09209ee2020-12-13 08:44:15 -0600132- :doc:`/overview-manual/index` *:* This manual provides overview
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500133 and conceptual information about the Yocto Project.
134
Andrew Geissler09209ee2020-12-13 08:44:15 -0600135- :doc:`/dev-manual/index` *:* This manual is a "how-to" guide
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500136 that presents procedures useful to both application and system
137 developers who use the Yocto Project.
138
Andrew Geissler09209ee2020-12-13 08:44:15 -0600139- :doc:`/sdk-manual/index` *manual :* This
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500140 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
Andrew Geissler09209ee2020-12-13 08:44:15 -0600145- :doc:`/bsp-guide/bsp` *:* This guide defines the structure
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500146 for BSP components. Having a commonly understood structure encourages
147 standardization.
148
Andrew Geissler09209ee2020-12-13 08:44:15 -0600149- :doc:`/kernel-dev/index` *:* This manual describes
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500150 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
Andrew Geissler09209ee2020-12-13 08:44:15 -0600154- :doc:`/ref-manual/index` *:* This
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500155 manual provides reference material such as variable, task, and class
156 descriptions.
157
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500158- :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`\ *:* This manual
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500159 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
Andrew Geissler09209ee2020-12-13 08:44:15 -0600164- :doc:`/profile-manual/index` *:* This manual presents a set of
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500165 common and generally useful tracing and profiling schemes along with
166 their applications (as appropriate) to each tool.
167
Andrew Geissler09209ee2020-12-13 08:44:15 -0600168- :doc:`/toaster-manual/index` *:* This manual
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500169 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
Andrew Geissler09209ee2020-12-13 08:44:15 -0600174- :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500175 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
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500183- :yocto_bugs:`Bugzilla <>`\ *:* The bug tracking application
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500184 the Yocto Project uses. If you find problems with the Yocto Project,
185 you should report them using this application.
186
Andrew Geissler09209ee2020-12-13 08:44:15 -0600187- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page
188 </Bugzilla_Configuration_and_Bug_Tracking>`\ *:*
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500189 Information on how to get set up and use the Yocto Project
190 implementation of Bugzilla for logging and tracking Yocto Project
191 defects.
192
193- *Internet Relay Chat (IRC):* Two IRC channels on freenode are
194 available for Yocto Project and Poky discussions: ``#yocto`` and
195 ``#poky``, respectively.
196
197- `Quick EMUlator (QEMU) <http://wiki.qemu.org/Index.html>`__\ *:* An
198 open-source machine emulator and virtualizer.