diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-11-20 20:17:33 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:00 +0000 |
commit | fa0cb4d34b1073f215fa3c680f2316208739d53d (patch) | |
tree | ba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/ref-manual/resources.rst | |
parent | a038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff) | |
download | poky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz |
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP
3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to'
the docs in 3.2, we agreed to backport sphinx docs onto 3.1.
This first patch brings all changes done in 3.2 until:
7f64574f7 README: include detailed information about sphinx
There are other changes after this commit, but they will be
selectively backported in individual patches.
This patch was generated with the following command:
git cherry-pick -n \
$(git log --reverse --oneline \
ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \
| cut -f1 -d' ')
The following commits were applies in the dunfell docs, but not in
master, so they were first reverted (and squashed into this change). A
commit will reintroduce the content from these patches in the Sphinx
files in a followup patch.
069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release
(From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/resources.rst')
-rw-r--r-- | documentation/ref-manual/resources.rst | 197 |
1 files changed, 197 insertions, 0 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst new file mode 100644 index 0000000000..2b82b79102 --- /dev/null +++ b/documentation/ref-manual/resources.rst | |||
@@ -0,0 +1,197 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-2.0-UK | ||
2 | |||
3 | **************************************** | ||
4 | Contributions and Additional Information | ||
5 | **************************************** | ||
6 | |||
7 | .. _resources-intro: | ||
8 | |||
9 | Introduction | ||
10 | ============ | ||
11 | |||
12 | The Yocto Project team is happy for people to experiment with the Yocto | ||
13 | Project. A number of places exist to find help if you run into | ||
14 | difficulties or find bugs. This presents information about contributing | ||
15 | and participating in the Yocto Project. | ||
16 | |||
17 | .. _resources-contributions: | ||
18 | |||
19 | Contributions | ||
20 | ============= | ||
21 | |||
22 | The Yocto Project gladly accepts contributions. You can submit changes | ||
23 | to the project either by creating and sending pull requests, or by | ||
24 | submitting patches through email. For information on how to do both as | ||
25 | well as information on how to identify the maintainer for each area of | ||
26 | code, see the ":ref:`how-to-submit-a-change`" section in the | ||
27 | Yocto Project Development Tasks Manual. | ||
28 | |||
29 | .. _resources-bugtracker: | ||
30 | |||
31 | Yocto Project Bugzilla | ||
32 | ====================== | ||
33 | |||
34 | The Yocto Project uses its own implementation of | ||
35 | :yocto_bugs:`Bugzilla <>` to track defects (bugs). | ||
36 | Implementations of Bugzilla work well for group development because they | ||
37 | track bugs and code changes, can be used to communicate changes and | ||
38 | problems with developers, can be used to submit and review patches, and | ||
39 | can be used to manage quality assurance. | ||
40 | |||
41 | Sometimes it is helpful to submit, investigate, or track a bug against | ||
42 | the Yocto Project itself (e.g. when discovering an issue with some | ||
43 | component of the build system that acts contrary to the documentation or | ||
44 | your expectations). | ||
45 | |||
46 | A general procedure and guidelines exist for when you use Bugzilla to | ||
47 | submit a bug. For information on how to use Bugzilla to submit a bug | ||
48 | against 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 | |||
55 | For information on Bugzilla in general, see http://www.bugzilla.org/about/. | ||
56 | |||
57 | .. _resources-mailinglist: | ||
58 | |||
59 | Mailing lists | ||
60 | ============= | ||
61 | |||
62 | A number of mailing lists maintained by the Yocto Project exist as well | ||
63 | as related OpenEmbedded mailing lists for discussion, patch submission | ||
64 | and announcements. To subscribe to one of the following mailing lists, | ||
65 | click on the appropriate URL in the following list and follow the | ||
66 | instructions: | ||
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 | |||
86 | For more Yocto Project-related mailing lists, see the | ||
87 | Yocto Project Website | ||
88 | . | ||
89 | .. _resources-irc: | ||
90 | |||
91 | Internet Relay Chat (IRC) | ||
92 | ========================= | ||
93 | |||
94 | Two IRC channels on freenode are available for the Yocto Project and | ||
95 | Poky discussions: | ||
96 | |||
97 | - ``#yocto`` | ||
98 | |||
99 | - ``#poky`` | ||
100 | |||
101 | .. _resources-links-and-related-documentation: | ||
102 | |||
103 | Links and Related Documentation | ||
104 | =============================== | ||
105 | |||
106 | Here 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. | ||