diff options
Diffstat (limited to 'documentation/ref-manual/resources.rst')
-rw-r--r-- | documentation/ref-manual/resources.rst | 104 |
1 files changed, 55 insertions, 49 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 7554164d11..4eaaca942e 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -10,7 +10,7 @@ Introduction | |||
10 | ============ | 10 | ============ |
11 | 11 | ||
12 | The Yocto Project team is happy for people to experiment with the Yocto | 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 | 13 | Project. There is a number of places where you can find help if you run into |
14 | difficulties or find bugs. This presents information about contributing | 14 | difficulties or find bugs. This presents information about contributing |
15 | and participating in the Yocto Project. | 15 | and participating in the Yocto Project. |
16 | 16 | ||
@@ -23,8 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes | |||
23 | to the project either by creating and sending pull requests, or by | 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 | 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 | 25 | well as information on how to identify the maintainer for each area of |
26 | code, see the ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the | 26 | code, see the :doc:`../contributor-guide/index`. |
27 | Yocto Project Development Tasks Manual. | ||
28 | 27 | ||
29 | .. _resources-bugtracker: | 28 | .. _resources-bugtracker: |
30 | 29 | ||
@@ -43,12 +42,11 @@ 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 | 42 | component of the build system that acts contrary to the documentation or |
44 | your expectations). | 43 | your expectations). |
45 | 44 | ||
46 | A general procedure and guidelines exist for when you use Bugzilla to | 45 | For a general procedure and guidelines on how to use Bugzilla to submit a bug |
47 | submit a bug. For information on how to use Bugzilla to submit a bug | ||
48 | against the Yocto Project, see the following: | 46 | against the Yocto Project, see the following: |
49 | 47 | ||
50 | - The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" | 48 | - The ":doc:`../contributor-guide/report-defect`" |
51 | section in the Yocto Project Development Tasks Manual. | 49 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
52 | 50 | ||
53 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 51 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
54 | 52 | ||
@@ -59,44 +57,49 @@ For information on Bugzilla in general, see https://www.bugzilla.org/about/. | |||
59 | Mailing lists | 57 | Mailing lists |
60 | ============= | 58 | ============= |
61 | 59 | ||
62 | A number of mailing lists maintained by the Yocto Project exist as well | 60 | There are multiple mailing lists maintained by the Yocto Project as well |
63 | as related OpenEmbedded mailing lists for discussion, patch submission | 61 | as related OpenEmbedded mailing lists for discussion, patch submission |
64 | and announcements. To subscribe to one of the following mailing lists, | 62 | and announcements. To subscribe to one of the following mailing lists, |
65 | click on the appropriate URL in the following list and follow the | 63 | click on the appropriate URL in the following list and follow the |
66 | instructions: | 64 | instructions: |
67 | 65 | ||
68 | - :yocto_lists:`/g/yocto` - General Yocto Project | 66 | - :yocto_lists:`/g/yocto` --- general Yocto Project |
69 | discussion mailing list. | 67 | discussion mailing list. |
70 | 68 | ||
71 | - :oe_lists:`/g/openembedded-core` - Discussion mailing | 69 | - :yocto_lists:`/g/yocto-patches` --- patch contribution mailing list for Yocto |
70 | Project-related layers which do not have their own mailing list. | ||
71 | |||
72 | - :oe_lists:`/g/openembedded-core` --- discussion mailing | ||
72 | list about OpenEmbedded-Core (the core metadata). | 73 | list about OpenEmbedded-Core (the core metadata). |
73 | 74 | ||
74 | - :oe_lists:`/g/openembedded-devel` - Discussion | 75 | - :oe_lists:`/g/openembedded-devel` --- discussion |
75 | mailing list about OpenEmbedded. | 76 | mailing list about OpenEmbedded. |
76 | 77 | ||
77 | - :oe_lists:`/g/bitbake-devel` - Discussion mailing | 78 | - :oe_lists:`/g/bitbake-devel` --- discussion mailing |
78 | list about the :term:`BitBake` build tool. | 79 | list about the :term:`BitBake` build tool. |
79 | 80 | ||
80 | - :yocto_lists:`/g/poky` - Discussion mailing list | 81 | - :yocto_lists:`/g/poky` --- discussion mailing list |
81 | about :term:`Poky`. | 82 | about :term:`Poky`. |
82 | 83 | ||
83 | - :yocto_lists:`/g/yocto-announce` - Mailing list to | 84 | - :yocto_lists:`/g/yocto-announce` --- mailing list to |
84 | receive official Yocto Project release and milestone announcements. | 85 | receive official Yocto Project release and milestone announcements. |
85 | 86 | ||
86 | For more Yocto Project-related mailing lists, see the | 87 | - :yocto_lists:`/g/docs` --- discussion mailing list about the Yocto Project |
87 | :yocto_home:`Yocto Project Website <>`. | 88 | documentation. |
89 | |||
90 | See also :yocto_home:`the description of all mailing lists </community/mailing-lists/>`. | ||
88 | 91 | ||
89 | .. _resources-irc: | 92 | .. _resources-irc: |
90 | 93 | ||
91 | Internet Relay Chat (IRC) | 94 | Internet Relay Chat (IRC) |
92 | ========================= | 95 | ========================= |
93 | 96 | ||
94 | Two IRC channels on freenode are available for the Yocto Project and | 97 | Two IRC channels on `Libera Chat <https://libera.chat/>`__ |
95 | Poky discussions: | 98 | are available for the Yocto Project and OpenEmbedded discussions: |
96 | 99 | ||
97 | - ``#yocto`` | 100 | - ``#yocto`` |
98 | 101 | ||
99 | - ``#poky`` | 102 | - ``#oe`` |
100 | 103 | ||
101 | .. _resources-links-and-related-documentation: | 104 | .. _resources-links-and-related-documentation: |
102 | 105 | ||
@@ -105,93 +108,96 @@ Links and Related Documentation | |||
105 | 108 | ||
106 | Here is a list of resources you might find helpful: | 109 | Here is a list of resources you might find helpful: |
107 | 110 | ||
108 | - :yocto_home:`The Yocto Project Website <>`\ *:* The home site | 111 | - :yocto_home:`The Yocto Project Website <>`: The home site |
109 | for the Yocto Project. | 112 | for the Yocto Project. |
110 | 113 | ||
111 | - :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for | 114 | - :yocto_wiki:`The Yocto Project Main Wiki Page <>`: The main wiki page for |
112 | the Yocto Project. This page contains information about project | 115 | the Yocto Project. This page contains information about project |
113 | planning, release engineering, QA & automation, a reference site map, | 116 | planning, release engineering, QA & automation, a reference site map, |
114 | and other resources related to the Yocto Project. | 117 | and other resources related to the Yocto Project. |
115 | 118 | ||
116 | - :oe_home:`OpenEmbedded <>`\ *:* The build system used by the | 119 | - :oe_home:`OpenEmbedded <>`: The build system used by the |
117 | Yocto Project. This project is the upstream, generic, embedded | 120 | Yocto Project. This project is the upstream, generic, embedded |
118 | distribution from which the Yocto Project derives its build system | 121 | distribution from which the Yocto Project derives its build system |
119 | (Poky) and to which it contributes. | 122 | (Poky) and to which it contributes. |
120 | 123 | ||
121 | - :oe_wiki:`BitBake </BitBake>`\ *:* The tool used to process metadata. | 124 | - :oe_wiki:`BitBake </BitBake>`: The tool used to process metadata. |
122 | 125 | ||
123 | - :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive | 126 | - :doc:`BitBake User Manual <bitbake:index>`: A comprehensive |
124 | guide to the BitBake tool. If you want information on BitBake, see | 127 | guide to the BitBake tool. If you want information on BitBake, see |
125 | this manual. | 128 | this manual. |
126 | 129 | ||
127 | - :doc:`/brief-yoctoprojectqs/index` *:* This | 130 | - :doc:`/brief-yoctoprojectqs/index`: This |
128 | short document lets you experience building an image using the Yocto | 131 | short document lets you experience building an image using the Yocto |
129 | Project without having to understand any concepts or details. | 132 | Project without having to understand any concepts or details. |
130 | 133 | ||
131 | - :doc:`/overview-manual/index` *:* This manual provides overview | 134 | - :doc:`/overview-manual/index`: This manual provides overview |
132 | and conceptual information about the Yocto Project. | 135 | and conceptual information about the Yocto Project. |
133 | 136 | ||
134 | - :doc:`/dev-manual/index` *:* This manual is a "how-to" guide | 137 | - :doc:`/dev-manual/index`: This manual is a "how-to" guide |
135 | that presents procedures useful to both application and system | 138 | that presents procedures useful to both application and system |
136 | developers who use the Yocto Project. | 139 | developers who use the Yocto Project. |
137 | 140 | ||
138 | - :doc:`/sdk-manual/index` *manual :* This | 141 | - :doc:`/sdk-manual/index` manual: This |
139 | guide provides information that lets you get going with the standard | 142 | guide provides information that lets you get going with the standard |
140 | or extensible SDK. An SDK, with its cross-development toolchains, | 143 | or extensible SDK. An SDK, with its cross-development toolchains, |
141 | allows you to develop projects inside or outside of the Yocto Project | 144 | allows you to develop projects inside or outside of the Yocto Project |
142 | environment. | 145 | environment. |
143 | 146 | ||
144 | - :doc:`/bsp-guide/bsp` *:* This guide defines the structure | 147 | - :doc:`/bsp-guide/bsp`: This guide defines the structure |
145 | for BSP components. Having a commonly understood structure encourages | 148 | for BSP components. Having a commonly understood structure encourages |
146 | standardization. | 149 | standardization. |
147 | 150 | ||
148 | - :doc:`/kernel-dev/index` *:* This manual describes | 151 | - :doc:`/kernel-dev/index`: This manual describes |
149 | how to work with Linux Yocto kernels as well as provides a bit of | 152 | how to work with Linux Yocto kernels as well as provides a bit of |
150 | conceptual information on the construction of the Yocto Linux kernel | 153 | conceptual information on the construction of the Yocto Linux kernel |
151 | tree. | 154 | tree. |
152 | 155 | ||
153 | - :doc:`/ref-manual/index` *:* This | 156 | - :doc:`/ref-manual/index`: This |
154 | manual provides reference material such as variable, task, and class | 157 | manual provides reference material such as variable, task, and class |
155 | descriptions. | 158 | descriptions. |
156 | 159 | ||
157 | - :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`\ *:* This manual | 160 | - :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`: This manual |
158 | is simply a single HTML file comprised of the bulk of the Yocto | 161 | is simply a single HTML file comprised of the bulk of the Yocto |
159 | Project manuals. The Mega-Manual primarily exists as a vehicle by | 162 | Project manuals. It makes it easy to search for phrases and terms used |
160 | which you can easily search for phrases and terms used in the Yocto | 163 | in the Yocto Project documentation set. |
161 | Project documentation set. | ||
162 | 164 | ||
163 | - :doc:`/profile-manual/index` *:* This manual presents a set of | 165 | - :doc:`/profile-manual/index`: This manual presents a set of |
164 | common and generally useful tracing and profiling schemes along with | 166 | common and generally useful tracing and profiling schemes along with |
165 | their applications (as appropriate) to each tool. | 167 | their applications (as appropriate) to each tool. |
166 | 168 | ||
167 | - :doc:`/toaster-manual/index` *:* This manual | 169 | - :doc:`/toaster-manual/index`: This manual |
168 | introduces and describes how to set up and use Toaster. Toaster is an | 170 | introduces and describes how to set up and use Toaster. Toaster is an |
169 | Application Programming Interface (API) and web-based interface to | 171 | Application Programming Interface (API) and web-based interface to |
170 | the :term:`OpenEmbedded Build System`, which uses | 172 | the :term:`OpenEmbedded Build System`, which uses |
171 | BitBake, that reports build information. | 173 | BitBake, that reports build information. |
172 | 174 | ||
173 | - :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked | 175 | - `Yocto Project BitBake extension for VSCode |
176 | <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__: | ||
177 | This extension provides a rich feature set when working with BitBake recipes | ||
178 | within the Visual Studio Code IDE. | ||
179 | |||
180 | - :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked | ||
174 | questions and their answers. | 181 | questions and their answers. |
175 | 182 | ||
176 | - *Release Notes:* Features, updates and known issues for the current | 183 | - :doc:`Release Information </migration-guides/index>`: |
177 | release of the Yocto Project. To access the Release Notes, go to the | 184 | Migration guides, release notes, new features, updates and known issues |
178 | :yocto_home:`Downloads </software-overview/downloads>` page on | 185 | for the current and past releases of the Yocto Project. |
179 | the Yocto Project website and click on the "RELEASE INFORMATION" link | ||
180 | for the appropriate release. | ||
181 | 186 | ||
182 | - :yocto_bugs:`Bugzilla <>`\ *:* The bug tracking application | 187 | - :yocto_bugs:`Bugzilla <>`: The bug tracking application |
183 | the Yocto Project uses. If you find problems with the Yocto Project, | 188 | the Yocto Project uses. If you find problems with the Yocto Project, |
184 | you should report them using this application. | 189 | you should report them using this application. |
185 | 190 | ||
186 | - :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page | 191 | - :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page |
187 | </Bugzilla_Configuration_and_Bug_Tracking>`\ *:* | 192 | </Bugzilla_Configuration_and_Bug_Tracking>`: |
188 | Information on how to get set up and use the Yocto Project | 193 | Information on how to get set up and use the Yocto Project |
189 | implementation of Bugzilla for logging and tracking Yocto Project | 194 | implementation of Bugzilla for logging and tracking Yocto Project |
190 | defects. | 195 | defects. |
191 | 196 | ||
192 | - *Internet Relay Chat (IRC):* Two IRC channels on freenode are | 197 | - Internet Relay Chat (IRC): Two IRC channels on |
193 | available for Yocto Project and Poky discussions: ``#yocto`` and | 198 | `Libera Chat <https://libera.chat/>`__ are |
194 | ``#poky``, respectively. | 199 | available for Yocto Project and OpenEmbeddded discussions: ``#yocto`` and |
200 | ``#oe``, respectively. | ||
195 | 201 | ||
196 | - `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__\ *:* An | 202 | - `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__: An |
197 | open-source machine emulator and virtualizer. | 203 | open-source machine emulator and virtualizer. |