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