diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-09-06 10:26:32 +0200 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2023-09-13 06:21:26 -1000 |
commit | 1c54f85cf94919a56cb2a106d8931f2e3dea160c (patch) | |
tree | 13b1a6487d4018eb5777e0e5580134c7eea9896c /documentation | |
parent | ca4a09f897f71d9d4a414ad8549a583a25f87b6a (diff) | |
download | poky-1c54f85cf94919a56cb2a106d8931f2e3dea160c.tar.gz |
manuals: add new contributor guide
(From yocto-docs rev: 77f20d1594db42818aac9a7a92865def8fb7ec36)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 4 | ||||
-rw-r--r-- | documentation/contributor-guide/identify-component.rst | 31 | ||||
-rw-r--r-- | documentation/contributor-guide/index.rst | 26 | ||||
-rw-r--r-- | documentation/contributor-guide/recipe-style-guide.rst | 257 | ||||
-rw-r--r-- | documentation/contributor-guide/report-defect.rst | 67 | ||||
-rw-r--r-- | documentation/contributor-guide/submit-changes.rst | 754 | ||||
-rw-r--r-- | documentation/dev-manual/changes.rst | 525 | ||||
-rw-r--r-- | documentation/dev-manual/debugging.rst | 7 | ||||
-rw-r--r-- | documentation/dev-manual/index.rst | 1 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 9 | ||||
-rw-r--r-- | documentation/dev-manual/vulnerabilities.rst | 2 | ||||
-rw-r--r-- | documentation/index.rst | 1 | ||||
-rw-r--r-- | documentation/overview-manual/development-environment.rst | 19 | ||||
-rw-r--r-- | documentation/ref-manual/resources.rst | 7 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 5 |
15 files changed, 1159 insertions, 556 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 4d64c65d91..3be314bcf6 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -927,8 +927,8 @@ Yocto Project: | |||
927 | - The name and contact information for the BSP layer maintainer. | 927 | - The name and contact information for the BSP layer maintainer. |
928 | This is the person to whom patches and questions should be sent. | 928 | This is the person to whom patches and questions should be sent. |
929 | For information on how to find the right person, see the | 929 | For information on how to find the right person, see the |
930 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 930 | :doc:`../contributor-guide/submit-changes` section in the Yocto Project and |
931 | section in the Yocto Project Development Tasks Manual. | 931 | OpenEmbedded Contributor Guide. |
932 | 932 | ||
933 | - Instructions on how to build the BSP using the BSP layer. | 933 | - Instructions on how to build the BSP using the BSP layer. |
934 | 934 | ||
diff --git a/documentation/contributor-guide/identify-component.rst b/documentation/contributor-guide/identify-component.rst new file mode 100644 index 0000000000..a28391a66a --- /dev/null +++ b/documentation/contributor-guide/identify-component.rst | |||
@@ -0,0 +1,31 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Identify the component | ||
4 | ********************** | ||
5 | |||
6 | The Yocto Project and OpenEmbedded ecosystem is built of :term:`layers <Layer>` | ||
7 | so the first step is to identify the component where the issue likely lies. | ||
8 | For example, if you have a hardware issue, it is likely related to the BSP | ||
9 | you are using and the best place to seek advice would be from the BSP provider | ||
10 | or :term:`layer`. If the issue is a build/configuration one and a distro is in | ||
11 | use, they would likely be the first place to ask questions. If the issue is a | ||
12 | generic one and/or in the core classes or metadata, the core layer or BitBake | ||
13 | might be the appropriate component. | ||
14 | |||
15 | Each metadata layer being used should contain a ``README`` file and that should | ||
16 | explain where to report issues, where to send changes and how to contact the | ||
17 | maintainers. | ||
18 | |||
19 | If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake, | ||
20 | issues can be reported in the :yocto_bugs:`Yocto Project Bugzilla <>`. The | ||
21 | :yocto_lists:`yocto </g/yocto>` mailing list is a general “catch-all” location | ||
22 | where questions can be sent if you can’t work out where something should go. | ||
23 | |||
24 | :term:`Poky` is a commonly used “combination” repository where multiple | ||
25 | components have been combined (:oe_git:`bitbake </bitbake>`, | ||
26 | :oe_git:`openembedded-core </openembedded-core>`, | ||
27 | :yocto_git:`meta-yocto </meta-yocto>` and | ||
28 | :yocto_git:`yocto-docs </yocto-docs>`). Patches should be submitted against the | ||
29 | appropriate individual component rather than :term:`Poky` itself as detailed in | ||
30 | the appropriate ``README`` file. | ||
31 | |||
diff --git a/documentation/contributor-guide/index.rst b/documentation/contributor-guide/index.rst new file mode 100644 index 0000000000..a832169455 --- /dev/null +++ b/documentation/contributor-guide/index.rst | |||
@@ -0,0 +1,26 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | ================================================ | ||
4 | Yocto Project and OpenEmbedded Contributor Guide | ||
5 | ================================================ | ||
6 | |||
7 | The Yocto Project and OpenEmbedded are open-source, community-based projects so | ||
8 | contributions are very welcome, it is how the code evolves and everyone can | ||
9 | effect change. Contributions take different forms, if you have a fix for an | ||
10 | issue you’ve run into, a patch is the most appropriate way to contribute it. | ||
11 | If you run into an issue but don’t have a solution, opening a defect in | ||
12 | :yocto_bugs:`Bugzilla <>` or asking questions on the mailing lists might be | ||
13 | more appropriate. This guide intends to point you in the right direction to | ||
14 | this. | ||
15 | |||
16 | |||
17 | .. toctree:: | ||
18 | :caption: Table of Contents | ||
19 | :numbered: | ||
20 | |||
21 | identify-component | ||
22 | report-defect | ||
23 | recipe-style-guide | ||
24 | submit-changes | ||
25 | |||
26 | .. include:: /boilerplate.rst | ||
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst new file mode 100644 index 0000000000..a0d513e8e9 --- /dev/null +++ b/documentation/contributor-guide/recipe-style-guide.rst | |||
@@ -0,0 +1,257 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Recipe Style Guide | ||
4 | ****************** | ||
5 | |||
6 | Recipe Naming Conventions | ||
7 | ========================= | ||
8 | |||
9 | In general, most recipes should follow the naming convention | ||
10 | ``recipes-category/package/packagename_version.bb``. Recipes for related | ||
11 | projects may share the same package directory. ``packagename``, ``category``, | ||
12 | and ``package`` may contain hyphens, but hyphens are not allowed in ``version``. | ||
13 | |||
14 | If the recipe is tracking a Git revision that does not correspond to a released | ||
15 | version of the software, ``version`` may be ``git`` (e.g. ``packagename_git.bb``) | ||
16 | |||
17 | Version Policy | ||
18 | ============== | ||
19 | |||
20 | Our versions follow the form ``<package epoch>:<package version>-<package revision>`` | ||
21 | or in BitBake variable terms ${:term:`PE`}:${:term:`PV`}-${:term:`PR`}. We | ||
22 | generally follow the `Debian <https://www.debian.org/doc/debian-policy/ch-controlfields.html#version>`__ | ||
23 | version policy which defines these terms. | ||
24 | |||
25 | In most cases the version :term:`PV` will be set automatically from the recipe | ||
26 | file name. It is recommended to use released versions of software as these are | ||
27 | revisions that upstream are expecting people to use. | ||
28 | |||
29 | Package versions should always compare and sort correctly so that upgrades work | ||
30 | as expected. With conventional versions such as ``1.4`` upgrading ``to 1.5`` | ||
31 | this happens naturally, but some versions don't sort. For example, | ||
32 | ``1.5 Release Candidate 2`` could be written as ``1.5rc2`` but this sorts after | ||
33 | ``1.5``, so upgrades from feeds won't happen correctly. | ||
34 | |||
35 | Instead the tilde (``~``) operator can be used, which sorts before the empty | ||
36 | string so ``1.5~rc2`` comes before ``1.5``. There is a historical syntax which | ||
37 | may be found where :term:`PV` is set as a combination of the prior version | ||
38 | ``+`` the pre-release version, for example ``PV=1.4+1.5rc2``. This is a valid | ||
39 | syntax but the tilde form is preferred. | ||
40 | |||
41 | For version comparisons, the ``opkg-compare-versions`` program from | ||
42 | ``opkg-utils`` can be useful when attempting to determine how two version | ||
43 | numbers compare to each other. Our definitive version comparison algorithm is | ||
44 | the one within bitbake which aims to match those of the package managers and | ||
45 | Debian policy closely. | ||
46 | |||
47 | When a recipe references a git revision that does not correspond to a released | ||
48 | version of software (e.g. is not a tagged version), the :term:`PV` variable | ||
49 | should include the Git revision using the following to make the | ||
50 | version clear:: | ||
51 | |||
52 | PV = "<version>+git${SRCPV}" | ||
53 | |||
54 | In this case, ``<version>`` should be the most recently released version of the | ||
55 | software from the current source revision (``git describe`` can be useful for | ||
56 | determining this). Whilst not recommended for published layers, this format is | ||
57 | also useful when using :term:`AUTOREV` to set the recipe to increment source | ||
58 | control revisions automatically, which can be useful during local development. | ||
59 | |||
60 | Version Number Changes | ||
61 | ====================== | ||
62 | |||
63 | The :term:`PR` variable is used to indicate different revisions of a recipe | ||
64 | that reference the same upstream source version. It can be used to force a | ||
65 | new version of a package to be installed onto a device from a package feed. | ||
66 | These once had to be set manually but in most cases these can now be set and | ||
67 | incremented automatically by a PR Server connected with a package feed. | ||
68 | |||
69 | When :term:`PV` increases, any existing :term:`PR` value can and should be | ||
70 | removed. | ||
71 | |||
72 | If :term:`PV` changes in such a way that it does not increase with respect to | ||
73 | the previous value, you need to increase :term:`PE` to ensure package managers | ||
74 | will upgrade it correctly. If unset you should set :term:`PE` to "1" since | ||
75 | the default of empty is easily confused with "0" depending on the package | ||
76 | manager. :term:`PE` can only have an integer value. | ||
77 | |||
78 | Recipe formatting | ||
79 | ================= | ||
80 | |||
81 | Variable Formatting | ||
82 | ------------------- | ||
83 | |||
84 | - Variable assignment should a space around each side of the operator, e.g. | ||
85 | ``FOO = "bar"``, not ``FOO="bar"``. | ||
86 | |||
87 | - Double quotes should be used on the right-hand side of the assignment, | ||
88 | e.g. ``FOO = "bar"`` not ``FOO = 'bar'`` | ||
89 | |||
90 | - Spaces should be used for indenting variables, with 4 spaces per tab | ||
91 | |||
92 | - Long variables should be split over multiple lines when possible by using | ||
93 | the continuation character (``\``) | ||
94 | |||
95 | - When splitting a long variable over multiple lines, all continuation lines | ||
96 | should be indented (with spaces) to align with the start of the quote on the | ||
97 | first line:: | ||
98 | |||
99 | FOO = "this line is \ | ||
100 | long \ | ||
101 | " | ||
102 | |||
103 | Instead of:: | ||
104 | |||
105 | FOO = "this line is \ | ||
106 | long \ | ||
107 | " | ||
108 | |||
109 | Python Function formatting | ||
110 | -------------------------- | ||
111 | |||
112 | - Spaces must be used for indenting Python code, with 4 spaces per tab | ||
113 | |||
114 | Shell Function formatting | ||
115 | ------------------------- | ||
116 | |||
117 | - The formatting of shell functions should be consistent within layers. | ||
118 | Some use tabs, some use spaces. | ||
119 | |||
120 | Recipe metadata | ||
121 | =============== | ||
122 | |||
123 | Required Variables | ||
124 | ------------------ | ||
125 | |||
126 | The following variables should be included in all recipes: | ||
127 | |||
128 | - :term:`SUMMARY`: a one line description of the upstream project | ||
129 | |||
130 | - :term:`DESCRIPTION`: an extended description of the upstream project, | ||
131 | possibly with multiple lines. If no reasonable description can be written, | ||
132 | this may be omitted as it defaults to :term:`SUMMARY`. | ||
133 | |||
134 | - :term:`HOMEPAGE`: the URL to the upstream projects homepage. | ||
135 | |||
136 | - :term:`BUGTRACKER`: the URL upstream projects bug tracking website, | ||
137 | if applicable. | ||
138 | |||
139 | Recipe Ordering | ||
140 | --------------- | ||
141 | |||
142 | When a variable is defined in recipes and classes, variables should follow the | ||
143 | general order when possible: | ||
144 | |||
145 | - :term:`SUMMARY` | ||
146 | - :term:`DESCRIPTION` | ||
147 | - :term:`HOMEPAGE` | ||
148 | - :term:`BUGTRACKER` | ||
149 | - :term:`SECTION` | ||
150 | - :term:`LICENSE` | ||
151 | - :term:`LIC_FILES_CHKSUM` | ||
152 | - :term:`DEPENDS` | ||
153 | - :term:`PROVIDES` | ||
154 | - :term:`PV` | ||
155 | - :term:`SRC_URI` | ||
156 | - :term:`SRCREV` | ||
157 | - :term:`S` | ||
158 | - ``inherit ...`` | ||
159 | - :term:`PACKAGECONFIG` | ||
160 | - Build class specific variables such as ``EXTRA_QMAKEVARS_POST`` and :term:`EXTRA_OECONF` | ||
161 | - Tasks such as :ref:`ref-tasks-configure` | ||
162 | - :term:`PACKAGE_ARCH` | ||
163 | - :term:`PACKAGES` | ||
164 | - :term:`FILES` | ||
165 | - :term:`RDEPENDS` | ||
166 | - :term:`RRECOMMENDS` | ||
167 | - :term:`RSUGGESTS` | ||
168 | - :term:`RPROVIDES` | ||
169 | - :term:`RCONFLICTS` | ||
170 | - :term:`BBCLASSEXTEND` | ||
171 | |||
172 | There are some cases where ordering is important and these cases would override | ||
173 | this default order. Examples include: | ||
174 | |||
175 | - :term:`PACKAGE_ARCH` needing to be set before ``inherit packagegroup`` | ||
176 | |||
177 | Tasks should be ordered based on the order they generally execute. For commonly | ||
178 | used tasks this would be: | ||
179 | |||
180 | - :ref:`ref-tasks-fetch` | ||
181 | - :ref:`ref-tasks-unpack` | ||
182 | - :ref:`ref-tasks-patch` | ||
183 | - :ref:`ref-tasks-prepare_recipe_sysroot` | ||
184 | - :ref:`ref-tasks-configure` | ||
185 | - :ref:`ref-tasks-compile` | ||
186 | - :ref:`ref-tasks-install` | ||
187 | - :ref:`ref-tasks-populate_sysroot` | ||
188 | - :ref:`ref-tasks-package` | ||
189 | |||
190 | Custom tasks should be sorted similarly. | ||
191 | |||
192 | Package specific variables are typically grouped together, e.g.:: | ||
193 | |||
194 | RDEPENDS:${PN} = “foo” | ||
195 | RDEPENDS:${PN}-libs = “bar” | ||
196 | |||
197 | RRECOMMENDS:${PN} = “one” | ||
198 | RRECOMMENDS:${PN}-libs = “two” | ||
199 | |||
200 | Recipe License Fields | ||
201 | --------------------- | ||
202 | |||
203 | Recipes need to define both the :term:`LICENSE` and | ||
204 | :term:`LIC_FILES_CHKSUM` variables: | ||
205 | |||
206 | - :term:`LICENSE`: This variable specifies the license for the software. | ||
207 | If you do not know the license under which the software you are | ||
208 | building is distributed, you should go to the source code and look | ||
209 | for that information. Typical files containing this information | ||
210 | include ``COPYING``, :term:`LICENSE`, and ``README`` files. You could | ||
211 | also find the information near the top of a source file. For example, | ||
212 | given a piece of software licensed under the GNU General Public | ||
213 | License version 2, you would set :term:`LICENSE` as follows:: | ||
214 | |||
215 | LICENSE = "GPL-2.0-only" | ||
216 | |||
217 | The licenses you specify within :term:`LICENSE` can have any name as long | ||
218 | as you do not use spaces, since spaces are used as separators between | ||
219 | license names. For standard licenses, use the names of the files in | ||
220 | ``meta/files/common-licenses/`` or the :term:`SPDXLICENSEMAP` flag names | ||
221 | defined in ``meta/conf/licenses.conf``. | ||
222 | |||
223 | - :term:`LIC_FILES_CHKSUM`: The OpenEmbedded build system uses this | ||
224 | variable to make sure the license text has not changed. If it has, | ||
225 | the build produces an error and it affords you the chance to figure | ||
226 | it out and correct the problem. | ||
227 | |||
228 | You need to specify all applicable licensing files for the software. | ||
229 | At the end of the configuration step, the build process will compare | ||
230 | the checksums of the files to be sure the text has not changed. Any | ||
231 | differences result in an error with the message containing the | ||
232 | current checksum. For more explanation and examples of how to set the | ||
233 | :term:`LIC_FILES_CHKSUM` variable, see the | ||
234 | ":ref:`dev-manual/licenses:tracking license changes`" section. | ||
235 | |||
236 | To determine the correct checksum string, you can list the | ||
237 | appropriate files in the :term:`LIC_FILES_CHKSUM` variable with incorrect | ||
238 | md5 strings, attempt to build the software, and then note the | ||
239 | resulting error messages that will report the correct md5 strings. | ||
240 | See the ":ref:`dev-manual/new-recipe:fetching code`" section for | ||
241 | additional information. | ||
242 | |||
243 | Here is an example that assumes the software has a ``COPYING`` file:: | ||
244 | |||
245 | LIC_FILES_CHKSUM = "file://COPYING;md5=xxx" | ||
246 | |||
247 | When you try to build the | ||
248 | software, the build system will produce an error and give you the | ||
249 | correct string that you can substitute into the recipe file for a | ||
250 | subsequent build. | ||
251 | |||
252 | Tips and Guidelines for Writing Recipes | ||
253 | --------------------------------------- | ||
254 | |||
255 | - Use :term:`BBCLASSEXTEND` instead of creating separate recipes such as ``-native`` | ||
256 | and ``-nativesdk`` ones, whenever possible. This avoids having to maintain multiple | ||
257 | recipe files at the same time. | ||
diff --git a/documentation/contributor-guide/report-defect.rst b/documentation/contributor-guide/report-defect.rst new file mode 100644 index 0000000000..8ef133b842 --- /dev/null +++ b/documentation/contributor-guide/report-defect.rst | |||
@@ -0,0 +1,67 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Reporting a Defect Against the Yocto Project and OpenEmbedded | ||
4 | ************************************************************** | ||
5 | |||
6 | You can use the Yocto Project instance of | ||
7 | `Bugzilla <https://www.bugzilla.org/about/>`__ to submit a defect (bug) | ||
8 | against BitBake, OpenEmbedded-Core, against any other Yocto Project component | ||
9 | or for tool issues. For additional information on this implementation of | ||
10 | Bugzilla see the ":ref:`Yocto Project Bugzilla <resources-bugtracker>`" section | ||
11 | in the Yocto Project Reference Manual. For more detail on any of the following | ||
12 | steps, see the Yocto Project | ||
13 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. | ||
14 | |||
15 | Use the following general steps to submit a bug: | ||
16 | |||
17 | #. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. | ||
18 | |||
19 | #. Click "File a Bug" to enter a new bug. | ||
20 | |||
21 | #. Choose the appropriate "Classification", "Product", and "Component" | ||
22 | for which the bug was found. Bugs for the Yocto Project fall into | ||
23 | one of several classifications, which in turn break down into | ||
24 | several products and components. For example, for a bug against the | ||
25 | ``meta-intel`` layer, you would choose "Build System, Metadata & | ||
26 | Runtime", "BSPs", and "bsps-meta-intel", respectively. | ||
27 | |||
28 | #. Choose the "Version" of the Yocto Project for which you found the | ||
29 | bug (e.g. &DISTRO;). | ||
30 | |||
31 | #. Determine and select the "Severity" of the bug. The severity | ||
32 | indicates how the bug impacted your work. | ||
33 | |||
34 | #. Choose the "Hardware" that the bug impacts. | ||
35 | |||
36 | #. Choose the "Architecture" that the bug impacts. | ||
37 | |||
38 | #. Choose a "Documentation change" item for the bug. Fixing a bug might | ||
39 | or might not affect the Yocto Project documentation. If you are | ||
40 | unsure of the impact to the documentation, select "Don't Know". | ||
41 | |||
42 | #. Provide a brief "Summary" of the bug. Try to limit your summary to | ||
43 | just a line or two and be sure to capture the essence of the bug. | ||
44 | |||
45 | #. Provide a detailed "Description" of the bug. You should provide as | ||
46 | much detail as you can about the context, behavior, output, and so | ||
47 | forth that surrounds the bug. You can even attach supporting files | ||
48 | for output from logs by using the "Add an attachment" button. | ||
49 | |||
50 | #. Click the "Submit Bug" button submit the bug. A new Bugzilla number | ||
51 | is assigned to the bug and the defect is logged in the bug tracking | ||
52 | system. | ||
53 | |||
54 | Once you file a bug, the bug is processed by the Yocto Project Bug | ||
55 | Triage Team and further details concerning the bug are assigned (e.g. | ||
56 | priority and owner). You are the "Submitter" of the bug and any further | ||
57 | categorization, progress, or comments on the bug result in Bugzilla | ||
58 | sending you an automated email concerning the particular change or | ||
59 | progress to the bug. | ||
60 | |||
61 | There are no guarantees about if or when a bug might be worked on since an | ||
62 | open-source project has no dedicated engineering resources. However, the | ||
63 | project does have a good track record of resolving common issues over the | ||
64 | medium and long term. We do encourage people to file bugs so issues are | ||
65 | at least known about. It helps other users when they find somebody having | ||
66 | the same issue as they do, and an issue that is unknown is much less likely | ||
67 | to ever be fixed! | ||
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst new file mode 100644 index 0000000000..cda2d12d25 --- /dev/null +++ b/documentation/contributor-guide/submit-changes.rst | |||
@@ -0,0 +1,754 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Contributing Changes to a Component | ||
4 | ************************************ | ||
5 | |||
6 | Contributions to the Yocto Project and OpenEmbedded are very welcome. | ||
7 | Because the system is extremely configurable and flexible, we recognize | ||
8 | that developers will want to extend, configure or optimize it for their | ||
9 | specific uses. | ||
10 | |||
11 | .. _ref-why-mailing-lists: | ||
12 | |||
13 | Contributing through mailing lists --- Why not using web-based workflows? | ||
14 | ========================================================================= | ||
15 | |||
16 | Both Yocto Project and OpenEmbedded have many key components that are | ||
17 | maintained by patches being submitted on mailing lists. We appreciate this | ||
18 | approach does look a little old fashioned when other workflows are available | ||
19 | through web technology such as GitHub, GitLab and others. Since we are often | ||
20 | asked this question, we’ve decided to document the reasons for using mailing | ||
21 | lists. | ||
22 | |||
23 | One significant factor is that we value peer review. When a change is proposed | ||
24 | to many of the core pieces of the project, it helps to have many eyes of review | ||
25 | go over them. Whilst there is ultimately one maintainer who needs to make the | ||
26 | final call on accepting or rejecting a patch, the review is made by many eyes | ||
27 | and the exact people reviewing it are likely unknown to the maintainer. It is | ||
28 | often the surprise reviewer that catches the most interesting issues! | ||
29 | |||
30 | This is in contrast to the "GitHub" style workflow where either just a | ||
31 | maintainer makes that review, or review is specifically requested from | ||
32 | nominated people. We believe there is significant value added to the codebase | ||
33 | by this peer review and that moving away from mailing lists would be to the | ||
34 | detriment of our code. | ||
35 | |||
36 | We also need to acknowledge that many of our developers are used to this | ||
37 | mailing list workflow and have worked with it for years, with tools and | ||
38 | processes built around it. Changing away from this would result in a loss | ||
39 | of key people from the project, which would again be to its detriment. | ||
40 | |||
41 | The projects are acutely aware that potential new contributors find the | ||
42 | mailing list approach off-putting and would prefer a web-based GUI. | ||
43 | Since we don’t believe that can work for us, the project is aiming to ensure | ||
44 | `patchwork <https://patchwork.yoctoproject.org/>`__ is available to help track | ||
45 | patch status and also looking at how tooling can provide more feedback to users | ||
46 | about patch status. We are looking at improving tools such as ``patchtest`` to | ||
47 | test user contributions before they hit the mailing lists and also at better | ||
48 | documenting how to use such workflows since we recognise that whilst this was | ||
49 | common knowledge a decade ago, it might not be as familiar now. | ||
50 | |||
51 | Preparing Changes for Submission | ||
52 | ================================ | ||
53 | |||
54 | Set up Git | ||
55 | ---------- | ||
56 | |||
57 | The first thing to do is to install Git packages. Here is an example | ||
58 | on Debian and Ubuntu:: | ||
59 | |||
60 | sudo aptitude install git-core git-email | ||
61 | |||
62 | Then, you need to set a name and e-mail address that Git will | ||
63 | use to identify your commits:: | ||
64 | |||
65 | git config --global user.name "Ada Lovelace" | ||
66 | git config --global user.email "ada.lovelace@gmail.com" | ||
67 | |||
68 | Clone the Git repository for the component to modify | ||
69 | ---------------------------------------------------- | ||
70 | |||
71 | After identifying the component to modify as described in the | ||
72 | ":doc:`../contributor-guide/identify-component`" section, clone the | ||
73 | corresponding Git repository. Here is an example for OpenEmbedded-Core:: | ||
74 | |||
75 | git clone https://git.openembedded.org/openembedded-core | ||
76 | cd openembedded-core | ||
77 | |||
78 | Create a new branch | ||
79 | ------------------- | ||
80 | |||
81 | Then, create a new branch in your local Git repository | ||
82 | for your changes, starting from the reference branch in the upstream | ||
83 | repository (often called ``master``):: | ||
84 | |||
85 | $ git checkout <ref-branch> | ||
86 | $ git checkout -b my-changes | ||
87 | |||
88 | If you have completely unrelated sets of changes to submit, you should even | ||
89 | create one branch for each set. | ||
90 | |||
91 | Implement and commit changes | ||
92 | ---------------------------- | ||
93 | |||
94 | In each branch, you should group your changes into small, controlled and | ||
95 | isolated ones. Keeping changes small and isolated aids review, makes | ||
96 | merging/rebasing easier and keeps the change history clean should anyone need | ||
97 | to refer to it in future. | ||
98 | |||
99 | To this purpose, you should create *one Git commit per change*, | ||
100 | corresponding to each of the patches you will eventually submit. | ||
101 | See `further guidance <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#separate-your-changes>`__ | ||
102 | in the Linux kernel documentation if needed. | ||
103 | |||
104 | For example, when you intend to add multiple new recipes, each recipe | ||
105 | should be added in a separate commit. For upgrades to existing recipes, | ||
106 | the previous version should usually be deleted as part of the same commit | ||
107 | to add the upgraded version. | ||
108 | |||
109 | #. *Stage Your Changes:* Stage your changes by using the ``git add`` | ||
110 | command on each file you modified. If you want to stage all the | ||
111 | files you modified, you can even use the ``git add -A`` command. | ||
112 | |||
113 | #. *Commit Your Changes:* This is when you can create separate commits. For | ||
114 | each commit to create, use the ``git commit -s`` command with the files | ||
115 | or directories you want to include in the commit:: | ||
116 | |||
117 | $ git commit -s file1 file2 dir1 dir2 ... | ||
118 | |||
119 | To include **a**\ ll staged files:: | ||
120 | |||
121 | $ git commit -sa | ||
122 | |||
123 | - The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line | ||
124 | to your commit message. There is the same requirement for contributing | ||
125 | to the Linux kernel. Adding such a line signifies that you, the | ||
126 | submitter, have agreed to the `Developer's Certificate of Origin 1.1 | ||
127 | <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>`__ | ||
128 | as follows: | ||
129 | |||
130 | .. code-block:: none | ||
131 | |||
132 | Developer's Certificate of Origin 1.1 | ||
133 | |||
134 | By making a contribution to this project, I certify that: | ||
135 | |||
136 | (a) The contribution was created in whole or in part by me and I | ||
137 | have the right to submit it under the open source license | ||
138 | indicated in the file; or | ||
139 | |||
140 | (b) The contribution is based upon previous work that, to the best | ||
141 | of my knowledge, is covered under an appropriate open source | ||
142 | license and I have the right under that license to submit that | ||
143 | work with modifications, whether created in whole or in part | ||
144 | by me, under the same open source license (unless I am | ||
145 | permitted to submit under a different license), as indicated | ||
146 | in the file; or | ||
147 | |||
148 | (c) The contribution was provided directly to me by some other | ||
149 | person who certified (a), (b) or (c) and I have not modified | ||
150 | it. | ||
151 | |||
152 | (d) I understand and agree that this project and the contribution | ||
153 | are public and that a record of the contribution (including all | ||
154 | personal information I submit with it, including my sign-off) is | ||
155 | maintained indefinitely and may be redistributed consistent with | ||
156 | this project or the open source license(s) involved. | ||
157 | |||
158 | - Provide a single-line summary of the change and, if more | ||
159 | explanation is needed, provide more detail in the body of the | ||
160 | commit. This summary is typically viewable in the "shortlist" of | ||
161 | changes. Thus, providing something short and descriptive that | ||
162 | gives the reader a summary of the change is useful when viewing a | ||
163 | list of many commits. You should prefix this short description | ||
164 | with the recipe name (if changing a recipe), or else with the | ||
165 | short form path to the file being changed. | ||
166 | |||
167 | .. note:: | ||
168 | |||
169 | To find a suitable prefix for the commit summary, a good idea | ||
170 | is to look for prefixes used in previous commits touching the | ||
171 | same files or directories:: | ||
172 | |||
173 | git log --oneline <paths> | ||
174 | |||
175 | - For the body of the commit message, provide detailed information | ||
176 | that describes what you changed, why you made the change, and the | ||
177 | approach you used. It might also be helpful if you mention how you | ||
178 | tested the change. Provide as much detail as you can in the body | ||
179 | of the commit message. | ||
180 | |||
181 | .. note:: | ||
182 | |||
183 | If the single line summary is enough to describe a simple | ||
184 | change, the body of the commit message can be left empty. | ||
185 | |||
186 | - If the change addresses a specific bug or issue that is associated | ||
187 | with a bug-tracking ID, include a reference to that ID in your | ||
188 | detailed description. For example, the Yocto Project uses a | ||
189 | specific convention for bug references --- any commit that addresses | ||
190 | a specific bug should use the following form for the detailed | ||
191 | description. Be sure to use the actual bug-tracking ID from | ||
192 | Bugzilla for bug-id:: | ||
193 | |||
194 | Fixes [YOCTO #bug-id] | ||
195 | |||
196 | detailed description of change | ||
197 | |||
198 | #. *Crediting contributors:* By using the ``git commit --amend`` command, | ||
199 | you can add some tags to the commit description to credit other contributors | ||
200 | to the change: | ||
201 | |||
202 | - ``Reported-by``: name and email of a person reporting a bug | ||
203 | that your commit is trying to fix. This is a good practice | ||
204 | to encourage people to go on reporting bugs and let them | ||
205 | know that their reports are taken into account. | ||
206 | |||
207 | - ``Suggested-by``: name and email of a person to credit for the | ||
208 | idea of making the change. | ||
209 | |||
210 | - ``Tested-by``, ``Reviewed-by``: name and email for people having | ||
211 | tested your changes or reviewed their code. These fields are | ||
212 | usually added by the maintainer accepting a patch, or by | ||
213 | yourself if you submitted your patches to early reviewers, | ||
214 | or are submitting an unmodified patch again as part of a | ||
215 | new iteration of your patch series. | ||
216 | |||
217 | - ``CC:`` Name and email of people you want to send a copy | ||
218 | of your changes to. This field will be used by ``git send-email``. | ||
219 | |||
220 | See `more guidance about using such tags | ||
221 | <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ | ||
222 | in the Linux kernel documentation. | ||
223 | |||
224 | Creating Patches | ||
225 | ================ | ||
226 | |||
227 | Here is the general procedure on how to create patches to be sent through email: | ||
228 | |||
229 | #. *Describe the Changes in your Branch:* If you have more than one commit | ||
230 | in your branch, it's recommended to provide a cover letter describing | ||
231 | the series of patches you are about to send. | ||
232 | |||
233 | For this purpose, a good solution is to store the cover letter contents | ||
234 | in the branch itself:: | ||
235 | |||
236 | git branch --edit-description | ||
237 | |||
238 | This will open a text editor to fill in the description for your | ||
239 | changes. This description can be updated when necessary and will | ||
240 | be used by Git to create the cover letter together with the patches. | ||
241 | |||
242 | It is recommended to start this description with a title line which | ||
243 | will serve a the subject line for the cover letter. | ||
244 | |||
245 | #. *Generate Patches for your Branch:* The ``git format-patch`` command will | ||
246 | generate patch files for each of the commits in your branch. You need | ||
247 | to pass the reference branch your branch starts from. | ||
248 | |||
249 | If you branch didn't need a description in the previous step:: | ||
250 | |||
251 | $ git format-patch <ref-branch> | ||
252 | |||
253 | If you filled a description for your branch, you will want to generate | ||
254 | a cover letter too:: | ||
255 | |||
256 | $ git format-patch --cover-letter --cover-from-description=auto <ref-branch> | ||
257 | |||
258 | After the command is run, the current directory contains numbered | ||
259 | ``.patch`` files for the commits in your branch. If you have a cover | ||
260 | letter, it will be in the ``0000-cover-letter.patch``. | ||
261 | |||
262 | .. note:: | ||
263 | |||
264 | The ``--cover-from-description=auto`` option makes ``git format-patch`` | ||
265 | use the first paragraph of the branch description as the cover | ||
266 | letter title. Another possibility, which is easier to remember, is to pass | ||
267 | only the ``--cover-letter`` option, but you will have to edit the | ||
268 | subject line manually every time you generate the patches. | ||
269 | |||
270 | See the `git format-patch manual page <https://git-scm.com/docs/git-format-patch>`__ | ||
271 | for details. | ||
272 | |||
273 | #. *Review each of the Patch Files:* This final review of the patches | ||
274 | before sending them often allows to view your changes from a different | ||
275 | perspective and discover defects such as typos, spacing issues or lines | ||
276 | or even files that you didn't intend to modify. This review should | ||
277 | include the cover letter patch too. | ||
278 | |||
279 | If necessary, rework your commits as described in | ||
280 | ":ref:`contributor-guide/submit-changes:taking patch review into account`". | ||
281 | |||
282 | Sending the Patches via Email | ||
283 | ============================= | ||
284 | |||
285 | Using Git to Send Patches | ||
286 | ------------------------- | ||
287 | |||
288 | To submit patches through email, it is very important that you send them | ||
289 | without any whitespace or HTML formatting that either you or your mailer | ||
290 | introduces. The maintainer that receives your patches needs to be able | ||
291 | to save and apply them directly from your emails, using the ``git am`` | ||
292 | command. | ||
293 | |||
294 | Using the ``git send-email`` command is the only error-proof way of sending | ||
295 | your patches using email since there is no risk of compromising whitespace | ||
296 | in the body of the message, which can occur when you use your own mail | ||
297 | client. It will also properly include your patches as *inline attachments*, | ||
298 | which is not easy to do with standard e-mail clients without breaking lines. | ||
299 | If you used your regular e-mail client and shared your patches as regular | ||
300 | attachments, reviewers wouldn't be able to quote specific sections of your | ||
301 | changes and make comments about them. | ||
302 | |||
303 | Setting up Git to Send Email | ||
304 | ---------------------------- | ||
305 | |||
306 | The ``git send-email`` command can send email by using a local or remote | ||
307 | Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or | ||
308 | through a direct SMTP configuration in your Git ``~/.gitconfig`` file. | ||
309 | |||
310 | Here are the settings for letting ``git send-email`` send e-mail through your | ||
311 | regular STMP server, using a Google Mail account as an example:: | ||
312 | |||
313 | git config --global sendemail.smtpserver smtp.gmail.com | ||
314 | git config --global sendemail.smtpserverport 587 | ||
315 | git config --global sendemail.smtpencryption tls | ||
316 | git config --global sendemail.smtpuser ada.lovelace@gmail.com | ||
317 | git config --global sendemail.smtppass = XXXXXXXX | ||
318 | |||
319 | These settings will appear in the ``.gitconfig`` file in your home directory. | ||
320 | |||
321 | If you neither can use a local MTA nor SMTP, make sure you use an email client | ||
322 | that does not touch the message (turning spaces in tabs, wrapping lines, etc.). | ||
323 | A good mail client to do so is Pine (or Alpine) or Mutt. For more | ||
324 | information about suitable clients, see `Email clients info for Linux | ||
325 | <https://www.kernel.org/doc/html/latest/process/email-clients.html>`__ | ||
326 | in the Linux kernel sources. | ||
327 | |||
328 | If you use such clients, just include the patch in the body of your email. | ||
329 | |||
330 | Finding a Suitable Mailing List | ||
331 | ------------------------------- | ||
332 | |||
333 | You should send patches to the appropriate mailing list so that they can be | ||
334 | reviewed by the right contributors and merged by the appropriate maintainer. | ||
335 | The specific mailing list you need to use depends on the location of the code | ||
336 | you are changing. | ||
337 | |||
338 | If people have concerns with any of the patches, they will usually voice | ||
339 | their concern over the mailing list. If patches do not receive any negative | ||
340 | reviews, the maintainer of the affected layer typically takes them, tests them, | ||
341 | and then based on successful testing, merges them. | ||
342 | |||
343 | In general, each component (e.g. layer) should have a ``README`` file | ||
344 | that indicates where to send the changes and which process to follow. | ||
345 | |||
346 | The "poky" repository, which is the Yocto Project's reference build | ||
347 | environment, is a hybrid repository that contains several individual | ||
348 | pieces (e.g. BitBake, Metadata, documentation, and so forth) built using | ||
349 | the combo-layer tool. The upstream location used for submitting changes | ||
350 | varies by component: | ||
351 | |||
352 | - *Core Metadata:* Send your patches to the | ||
353 | :oe_lists:`openembedded-core </g/openembedded-core>` | ||
354 | mailing list. For example, a change to anything under the ``meta`` or | ||
355 | ``scripts`` directories should be sent to this mailing list. | ||
356 | |||
357 | - *BitBake:* For changes to BitBake (i.e. anything under the | ||
358 | ``bitbake`` directory), send your patches to the | ||
359 | :oe_lists:`bitbake-devel </g/bitbake-devel>` | ||
360 | mailing list. | ||
361 | |||
362 | - *"meta-\*" trees:* These trees contain Metadata. Use the | ||
363 | :yocto_lists:`poky </g/poky>` mailing list. | ||
364 | |||
365 | - *Documentation*: For changes to the Yocto Project documentation, use the | ||
366 | :yocto_lists:`docs </g/docs>` mailing list. | ||
367 | |||
368 | For changes to other layers and tools hosted in the Yocto Project source | ||
369 | repositories (i.e. :yocto_git:`git.yoctoproject.org <>`), use the | ||
370 | :yocto_lists:`yocto </g/yocto/>` general mailing list. | ||
371 | |||
372 | For changes to other layers hosted in the OpenEmbedded source | ||
373 | repositories (i.e. :oe_git:`git.openembedded.org <>`), use | ||
374 | the :oe_lists:`openembedded-devel </g/openembedded-devel>` | ||
375 | mailing list, unless specified otherwise in the layer's ``README`` file. | ||
376 | |||
377 | If you intend to submit a new recipe that neither fits into the core Metadata, | ||
378 | nor into :oe_git:`meta-openembedded </meta-openembedded/>`, you should | ||
379 | look for a suitable layer in https://layers.openembedded.org. If similar | ||
380 | recipes can be expected, you may consider :ref:`dev-manual/layers:creating your own layer`. | ||
381 | |||
382 | If in doubt, please ask on the :yocto_lists:`yocto </g/yocto/>` general mailing list | ||
383 | or on the :oe_lists:`openembedded-devel </g/openembedded-devel>` mailing list. | ||
384 | |||
385 | Subscribing to the Mailing List | ||
386 | ------------------------------- | ||
387 | |||
388 | After identifying the right mailing list to use, you will have to subscribe to | ||
389 | it if you haven't done it yet. | ||
390 | |||
391 | If you attempt to send patches to a list you haven't subscribed to, your email | ||
392 | will be returned as undelivered. | ||
393 | |||
394 | However, if you don't want to be receive all the messages sent to a mailing list, | ||
395 | you can set your subscription to "no email". You will still be a subscriber able | ||
396 | to send messages, but you won't receive any e-mail. If people reply to your message, | ||
397 | their e-mail clients will default to including your email address in the | ||
398 | conversation anyway. | ||
399 | |||
400 | Anyway, you'll also be able to access the new messages on mailing list archives, | ||
401 | either through a web browser, or for the lists archived on https://lore.kernelorg, | ||
402 | through an individual newsgroup feed or a git repository. | ||
403 | |||
404 | Sending Patches via Email | ||
405 | ------------------------- | ||
406 | |||
407 | At this stage, you are ready to send your patches via email. Here's the | ||
408 | typical usage of ``git send-email``:: | ||
409 | |||
410 | git send-email --to <mailing-list-address> *.patch | ||
411 | |||
412 | Then, review each subject line and list of recipients carefully, and then | ||
413 | and then allow the command to send each message. | ||
414 | |||
415 | You will see that ``git send-email`` will automatically copy the people listed | ||
416 | in any commit tags such as ``Signed-off-by`` or ``Reported-by``. | ||
417 | |||
418 | In case you are sending patches for :oe_git:`meta-openembedded </meta-openembedded/>` | ||
419 | or any layer other than :oe_git:`openembedded-core </openembedded-core/>`, | ||
420 | please add the appropriate prefix so that it is clear which layer the patch is intended | ||
421 | to be applied to:: | ||
422 | |||
423 | git send-email --subject-prefix="meta-oe][PATCH" ... | ||
424 | |||
425 | .. note:: | ||
426 | |||
427 | It is actually possible to send patches without generating them | ||
428 | first. However, make sure you have reviewed your changes carefully | ||
429 | because ``git send-email`` will just show you the title lines of | ||
430 | each patch. | ||
431 | |||
432 | Here's a command you can use if you just have one patch in your | ||
433 | branch:: | ||
434 | |||
435 | git send-email --to <mailing-list-address> -1 | ||
436 | |||
437 | If you have multiple patches and a cover letter, you can send | ||
438 | patches for all the commits between the reference branch | ||
439 | and the tip of your branch:: | ||
440 | |||
441 | git send-email --cover-letter --cover-from-description=auto --to <mailing-list-address> -M <ref-branch> | ||
442 | |||
443 | See the `git send-email manual page <https://git-scm.com/docs/git-send-email>`__ | ||
444 | for details. | ||
445 | |||
446 | Troubleshooting Email Issues | ||
447 | ---------------------------- | ||
448 | |||
449 | Fixing your From identity | ||
450 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
451 | |||
452 | We have a frequent issue with contributors whose patches are received through | ||
453 | a ``From`` field which doesn't match the ``Signed-off-by`` information. Here is | ||
454 | a typical example for people sending from a domain name with :wikipedia:`DMARC`:: | ||
455 | |||
456 | From: "Linus Torvalds via lists.openembedded.org <linus.torvalds=kernel.org@lists.openembedded.org>" | ||
457 | |||
458 | This ``From`` field is used by ``git am`` to recreate commits with the right | ||
459 | author name. The following will ensure that your e-mails have an additional | ||
460 | ``From`` field at the beginning of the Email body, and therefore that | ||
461 | maintainers accepting your patches don't have to fix commit author information | ||
462 | manually:: | ||
463 | |||
464 | git config --global sendemail.from "linus.torvalds@kernel.org" | ||
465 | |||
466 | The ``sendemail.from`` should match your ``user.email`` setting, | ||
467 | which appears in the ``Signed-off-by`` line of your commits. | ||
468 | |||
469 | Streamlining git send-email usage | ||
470 | --------------------------------- | ||
471 | |||
472 | If you want to save time and not be forced to remember the right options to use | ||
473 | with ``git send-email``, you can use Git configuration settings. | ||
474 | |||
475 | - To set the right mailing list address for a given repository:: | ||
476 | |||
477 | git config --local sendemail.to openembedded-devel@lists.openembedded.org | ||
478 | |||
479 | - If the mailing list requires a subject prefix for the layer | ||
480 | (this only works when the repository only contains one layer):: | ||
481 | |||
482 | git config --local format.subjectprefix "meta-something][PATCH" | ||
483 | |||
484 | Using Scripts to Push a Change Upstream and Request a Pull | ||
485 | ========================================================== | ||
486 | |||
487 | For larger patch series it is preferable to send a pull request which not | ||
488 | only includes the patch but also a pointer to a branch that can be pulled | ||
489 | from. This involves making a local branch for your changes, pushing this | ||
490 | branch to an accessible repository and then using the ``create-pull-request`` | ||
491 | and ``send-pull-request`` scripts from openembedded-core to create and send a | ||
492 | patch series with a link to the branch for review. | ||
493 | |||
494 | Follow this procedure to push a change to an upstream "contrib" Git | ||
495 | repository once the steps in | ||
496 | ":ref:`contributor-guide/submit-changes:preparing changes for submission`" | ||
497 | have been followed: | ||
498 | |||
499 | .. note:: | ||
500 | |||
501 | You can find general Git information on how to push a change upstream | ||
502 | in the | ||
503 | `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__. | ||
504 | |||
505 | #. *Request Push Access to an "Upstream" Contrib Repository:* Send an email to | ||
506 | ``helpdesk@yoctoproject.org``: | ||
507 | |||
508 | - Attach your SSH public key which usually named ``id_rsa.pub.``. | ||
509 | If you don't have one generate it by running ``ssh-keygen -t rsa -b 4096 -C "your_email@example.com"``. | ||
510 | |||
511 | - List the repositories you're planning to contribute to. | ||
512 | |||
513 | - Include your preferred branch prefix for ``-contrib`` repositories. | ||
514 | |||
515 | #. *Push Your Commits to the "Contrib" Upstream:* Push your | ||
516 | changes to that repository:: | ||
517 | |||
518 | $ git push upstream_remote_repo local_branch_name | ||
519 | |||
520 | For example, suppose you have permissions to push | ||
521 | into the upstream ``meta-intel-contrib`` repository and you are | ||
522 | working in a local branch named `your_name`\ ``/README``. The following | ||
523 | command pushes your local commits to the ``meta-intel-contrib`` | ||
524 | upstream repository and puts the commit in a branch named | ||
525 | `your_name`\ ``/README``:: | ||
526 | |||
527 | $ git push meta-intel-contrib your_name/README | ||
528 | |||
529 | #. *Determine Who to Notify:* Determine the maintainer or the mailing | ||
530 | list that you need to notify for the change. | ||
531 | |||
532 | Before submitting any change, you need to be sure who the maintainer | ||
533 | is or what mailing list that you need to notify. Use either these | ||
534 | methods to find out: | ||
535 | |||
536 | - *Maintenance File:* Examine the ``maintainers.inc`` file, which is | ||
537 | located in the :term:`Source Directory` at | ||
538 | ``meta/conf/distro/include``, to see who is responsible for code. | ||
539 | |||
540 | - *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can | ||
541 | enter the following command to bring up a short list of all | ||
542 | commits against a specific file:: | ||
543 | |||
544 | git shortlog -- filename | ||
545 | |||
546 | Just provide the name of the file for which you are interested. The | ||
547 | information returned is not ordered by history but does include a | ||
548 | list of everyone who has committed grouped by name. From the list, | ||
549 | you can see who is responsible for the bulk of the changes against | ||
550 | the file. | ||
551 | |||
552 | - *Find the Mailing List to Use:* See the | ||
553 | ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" | ||
554 | section above. | ||
555 | |||
556 | #. *Make a Pull Request:* Notify the maintainer or the mailing list that | ||
557 | you have pushed a change by making a pull request. | ||
558 | |||
559 | The Yocto Project provides two scripts that conveniently let you | ||
560 | generate and send pull requests to the Yocto Project. These scripts | ||
561 | are ``create-pull-request`` and ``send-pull-request``. You can find | ||
562 | these scripts in the ``scripts`` directory within the | ||
563 | :term:`Source Directory` (e.g. | ||
564 | ``poky/scripts``). | ||
565 | |||
566 | Using these scripts correctly formats the requests without | ||
567 | introducing any whitespace or HTML formatting. The maintainer that | ||
568 | receives your patches either directly or through the mailing list | ||
569 | needs to be able to save and apply them directly from your emails. | ||
570 | Using these scripts is the preferred method for sending patches. | ||
571 | |||
572 | First, create the pull request. For example, the following command | ||
573 | runs the script, specifies the upstream repository in the contrib | ||
574 | directory into which you pushed the change, and provides a subject | ||
575 | line in the created patch files:: | ||
576 | |||
577 | $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" | ||
578 | |||
579 | Running this script forms ``*.patch`` files in a folder named | ||
580 | ``pull-``\ `PID` in the current directory. One of the patch files is a | ||
581 | cover letter. | ||
582 | |||
583 | Before running the ``send-pull-request`` script, you must edit the | ||
584 | cover letter patch to insert information about your change. After | ||
585 | editing the cover letter, send the pull request. For example, the | ||
586 | following command runs the script and specifies the patch directory | ||
587 | and email address. In this example, the email address is a mailing | ||
588 | list:: | ||
589 | |||
590 | $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@lists.yoctoproject.org | ||
591 | |||
592 | You need to follow the prompts as the script is interactive. | ||
593 | |||
594 | .. note:: | ||
595 | |||
596 | For help on using these scripts, simply provide the ``-h`` | ||
597 | argument as follows:: | ||
598 | |||
599 | $ poky/scripts/create-pull-request -h | ||
600 | $ poky/scripts/send-pull-request -h | ||
601 | |||
602 | Submitting Changes to Stable Release Branches | ||
603 | ============================================= | ||
604 | |||
605 | The process for proposing changes to a Yocto Project stable branch differs | ||
606 | from the steps described above. Changes to a stable branch must address | ||
607 | identified bugs or CVEs and should be made carefully in order to avoid the | ||
608 | risk of introducing new bugs or breaking backwards compatibility. Typically | ||
609 | bug fixes must already be accepted into the master branch before they can be | ||
610 | backported to a stable branch unless the bug in question does not affect the | ||
611 | master branch or the fix on the master branch is unsuitable for backporting. | ||
612 | |||
613 | The list of stable branches along with the status and maintainer for each | ||
614 | branch can be obtained from the | ||
615 | :yocto_wiki:`Releases wiki page </Releases>`. | ||
616 | |||
617 | .. note:: | ||
618 | |||
619 | Changes will not typically be accepted for branches which are marked as | ||
620 | End-Of-Life (EOL). | ||
621 | |||
622 | With this in mind, the steps to submit a change for a stable branch are as | ||
623 | follows: | ||
624 | |||
625 | #. *Identify the bug or CVE to be fixed:* This information should be | ||
626 | collected so that it can be included in your submission. | ||
627 | |||
628 | See :ref:`dev-manual/vulnerabilities:checking for vulnerabilities` | ||
629 | for details about CVE tracking. | ||
630 | |||
631 | #. *Check if the fix is already present in the master branch:* This will | ||
632 | result in the most straightforward path into the stable branch for the | ||
633 | fix. | ||
634 | |||
635 | #. *If the fix is present in the master branch --- submit a backport request | ||
636 | by email:* You should send an email to the relevant stable branch | ||
637 | maintainer and the mailing list with details of the bug or CVE to be | ||
638 | fixed, the commit hash on the master branch that fixes the issue and | ||
639 | the stable branches which you would like this fix to be backported to. | ||
640 | |||
641 | #. *If the fix is not present in the master branch --- submit the fix to the | ||
642 | master branch first:* This will ensure that the fix passes through the | ||
643 | project's usual patch review and test processes before being accepted. | ||
644 | It will also ensure that bugs are not left unresolved in the master | ||
645 | branch itself. Once the fix is accepted in the master branch a backport | ||
646 | request can be submitted as above. | ||
647 | |||
648 | #. *If the fix is unsuitable for the master branch --- submit a patch | ||
649 | directly for the stable branch:* This method should be considered as a | ||
650 | last resort. It is typically necessary when the master branch is using | ||
651 | a newer version of the software which includes an upstream fix for the | ||
652 | issue or when the issue has been fixed on the master branch in a way | ||
653 | that introduces backwards incompatible changes. In this case follow the | ||
654 | steps in ":ref:`contributor-guide/submit-changes:preparing changes for submission`" | ||
655 | and in the following sections but modify the subject header of your patch | ||
656 | email to include the name of the stable branch which you are | ||
657 | targetting. This can be done using the ``--subject-prefix`` argument to | ||
658 | ``git format-patch``, for example to submit a patch to the | ||
659 | "&DISTRO_NAME_NO_CAP_MINUS_ONE;" branch use:: | ||
660 | |||
661 | git format-patch --subject-prefix='&DISTRO_NAME_NO_CAP_MINUS_ONE;][PATCH' ... | ||
662 | |||
663 | Taking Patch Review into Account | ||
664 | ================================ | ||
665 | |||
666 | You may get feedback on your submitted patches from other community members | ||
667 | or from the automated patchtest service. If issues are identified in your | ||
668 | patches then it is usually necessary to address these before the patches are | ||
669 | accepted into the project. In this case you should your commits according | ||
670 | to the feedback and submit an updated version to the relevant mailing list. | ||
671 | |||
672 | In any case, never fix reported issues by fixing them in new commits | ||
673 | on the tip of your branch. Always come up with a new series of commits | ||
674 | without the reported issues. | ||
675 | |||
676 | .. note:: | ||
677 | |||
678 | It is a good idea to send a copy to the reviewers who provided feedback | ||
679 | to the previous version of the patch. You can make sure this happens | ||
680 | by adding a ``CC`` tag to the commit description:: | ||
681 | |||
682 | CC: William Shakespeare <bill@yoctoproject.org> | ||
683 | |||
684 | A single patch can be amended using ``git commit --amend``, and multiple | ||
685 | patches can be easily reworked and reordered through an interactive Git rebase:: | ||
686 | |||
687 | git rebase -i <ref-branch> | ||
688 | |||
689 | See `this tutorial <https://hackernoon.com/beginners-guide-to-interactive-rebasing-346a3f9c3a6d>`__ | ||
690 | for practical guidance about using Git interactive rebasing. | ||
691 | |||
692 | You should also modify the ``[PATCH]`` tag in the email subject line when | ||
693 | sending the revised patch to mark the new iteration as ``[PATCH v2]``, | ||
694 | ``[PATCH v3]``, etc as appropriate. This can be done by passing the ``-v`` | ||
695 | argument to ``git format-patch`` with a version number:: | ||
696 | |||
697 | git format-patch -v2 <ref-branch> | ||
698 | |||
699 | Lastly please ensure that you also test your revised changes. In particular | ||
700 | please don't just edit the patch file written out by ``git format-patch`` and | ||
701 | resend it. | ||
702 | |||
703 | Tracking the Status of Patches | ||
704 | ============================== | ||
705 | |||
706 | The Yocto Project uses a `Patchwork instance <https://patchwork.yoctoproject.org/>`__ | ||
707 | to track the status of patches submitted to the various mailing lists and to | ||
708 | support automated patch testing. Each submitted patch is checked for common | ||
709 | mistakes and deviations from the expected patch format and submitters are | ||
710 | notified by ``patchtest`` if such mistakes are found. This process helps to | ||
711 | reduce the burden of patch review on maintainers. | ||
712 | |||
713 | .. note:: | ||
714 | |||
715 | This system is imperfect and changes can sometimes get lost in the flow. | ||
716 | Asking about the status of a patch or change is reasonable if the change | ||
717 | has been idle for a while with no feedback. | ||
718 | |||
719 | If your patches have not had any feedback in a few days, they may have already | ||
720 | been merged. You can run ``git pull`` branch to check this. Note that many if | ||
721 | not most layer maintainers do not send out acknowledgement emails when they | ||
722 | accept patches. Alternatively, if there is no response or merge after a few days | ||
723 | the patch may have been missed or the appropriate reviewers may not currently be | ||
724 | around. It is then perfectly fine to reply to it yourself with a reminder asking | ||
725 | for feedback. | ||
726 | |||
727 | .. note:: | ||
728 | |||
729 | Patch reviews for feature and recipe upgrade patches are likely be delayed | ||
730 | during a feature freeze because these types of patches aren't merged during | ||
731 | at that time --- you may have to wait until after the freeze is lifted. | ||
732 | |||
733 | Maintainers also commonly use ``-next`` branches to test submissions prior to | ||
734 | merging patches. Thus, you can get an idea of the status of a patch based on | ||
735 | whether the patch has been merged into one of these branches. The commonly | ||
736 | used testing branches for OpenEmbedded-Core are as follows: | ||
737 | |||
738 | - *openembedded-core "master-next" branch:* This branch is part of the | ||
739 | :oe_git:`openembedded-core </openembedded-core/>` repository and contains | ||
740 | proposed changes to the core metadata. | ||
741 | |||
742 | - *poky "master-next" branch:* This branch is part of the | ||
743 | :yocto_git:`poky </poky/>` repository and combines proposed | ||
744 | changes to BitBake, the core metadata and the poky distro. | ||
745 | |||
746 | Similarly, stable branches maintained by the project may have corresponding | ||
747 | ``-next`` branches which collect proposed changes. For example, | ||
748 | ``&DISTRO_NAME_NO_CAP;-next`` and ``&DISTRO_NAME_NO_CAP_MINUS_ONE;-next`` | ||
749 | branches in both the "openembdedded-core" and "poky" repositories. | ||
750 | |||
751 | Other layers may have similar testing branches but there is no formal | ||
752 | requirement or standard for these so please check the documentation for the | ||
753 | layers you are contributing to. | ||
754 | |||
diff --git a/documentation/dev-manual/changes.rst b/documentation/dev-manual/changes.rst deleted file mode 100644 index 9db6ce010c..0000000000 --- a/documentation/dev-manual/changes.rst +++ /dev/null | |||
@@ -1,525 +0,0 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Making Changes to the Yocto Project | ||
4 | *********************************** | ||
5 | |||
6 | Because the Yocto Project is an open-source, community-based project, | ||
7 | you can effect changes to the project. This section presents procedures | ||
8 | that show you how to submit a defect against the project and how to | ||
9 | submit a change. | ||
10 | |||
11 | Submitting a Defect Against the Yocto Project | ||
12 | ============================================= | ||
13 | |||
14 | Use the Yocto Project implementation of | ||
15 | `Bugzilla <https://www.bugzilla.org/about/>`__ to submit a defect (bug) | ||
16 | against the Yocto Project. For additional information on this | ||
17 | implementation of Bugzilla see the ":ref:`Yocto Project | ||
18 | Bugzilla <resources-bugtracker>`" section in the | ||
19 | Yocto Project Reference Manual. For more detail on any of the following | ||
20 | steps, see the Yocto Project | ||
21 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. | ||
22 | |||
23 | Use the following general steps to submit a bug: | ||
24 | |||
25 | #. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. | ||
26 | |||
27 | #. Click "File a Bug" to enter a new bug. | ||
28 | |||
29 | #. Choose the appropriate "Classification", "Product", and "Component" | ||
30 | for which the bug was found. Bugs for the Yocto Project fall into | ||
31 | one of several classifications, which in turn break down into | ||
32 | several products and components. For example, for a bug against the | ||
33 | ``meta-intel`` layer, you would choose "Build System, Metadata & | ||
34 | Runtime", "BSPs", and "bsps-meta-intel", respectively. | ||
35 | |||
36 | #. Choose the "Version" of the Yocto Project for which you found the | ||
37 | bug (e.g. &DISTRO;). | ||
38 | |||
39 | #. Determine and select the "Severity" of the bug. The severity | ||
40 | indicates how the bug impacted your work. | ||
41 | |||
42 | #. Choose the "Hardware" that the bug impacts. | ||
43 | |||
44 | #. Choose the "Architecture" that the bug impacts. | ||
45 | |||
46 | #. Choose a "Documentation change" item for the bug. Fixing a bug might | ||
47 | or might not affect the Yocto Project documentation. If you are | ||
48 | unsure of the impact to the documentation, select "Don't Know". | ||
49 | |||
50 | #. Provide a brief "Summary" of the bug. Try to limit your summary to | ||
51 | just a line or two and be sure to capture the essence of the bug. | ||
52 | |||
53 | #. Provide a detailed "Description" of the bug. You should provide as | ||
54 | much detail as you can about the context, behavior, output, and so | ||
55 | forth that surrounds the bug. You can even attach supporting files | ||
56 | for output from logs by using the "Add an attachment" button. | ||
57 | |||
58 | #. Click the "Submit Bug" button submit the bug. A new Bugzilla number | ||
59 | is assigned to the bug and the defect is logged in the bug tracking | ||
60 | system. | ||
61 | |||
62 | Once you file a bug, the bug is processed by the Yocto Project Bug | ||
63 | Triage Team and further details concerning the bug are assigned (e.g. | ||
64 | priority and owner). You are the "Submitter" of the bug and any further | ||
65 | categorization, progress, or comments on the bug result in Bugzilla | ||
66 | sending you an automated email concerning the particular change or | ||
67 | progress to the bug. | ||
68 | |||
69 | Submitting a Change to the Yocto Project | ||
70 | ======================================== | ||
71 | |||
72 | Contributions to the Yocto Project and OpenEmbedded are very welcome. | ||
73 | Because the system is extremely configurable and flexible, we recognize | ||
74 | that developers will want to extend, configure or optimize it for their | ||
75 | specific uses. | ||
76 | |||
77 | The Yocto Project uses a mailing list and a patch-based workflow that is | ||
78 | similar to the Linux kernel but contains important differences. In | ||
79 | general, there is a mailing list through which you can submit patches. You | ||
80 | should send patches to the appropriate mailing list so that they can be | ||
81 | reviewed and merged by the appropriate maintainer. The specific mailing | ||
82 | list you need to use depends on the location of the code you are | ||
83 | changing. Each component (e.g. layer) should have a ``README`` file that | ||
84 | indicates where to send the changes and which process to follow. | ||
85 | |||
86 | You can send the patch to the mailing list using whichever approach you | ||
87 | feel comfortable with to generate the patch. Once sent, the patch is | ||
88 | usually reviewed by the community at large. If somebody has concerns | ||
89 | with the patch, they will usually voice their concern over the mailing | ||
90 | list. If a patch does not receive any negative reviews, the maintainer | ||
91 | of the affected layer typically takes the patch, tests it, and then | ||
92 | based on successful testing, merges the patch. | ||
93 | |||
94 | The "poky" repository, which is the Yocto Project's reference build | ||
95 | environment, is a hybrid repository that contains several individual | ||
96 | pieces (e.g. BitBake, Metadata, documentation, and so forth) built using | ||
97 | the combo-layer tool. The upstream location used for submitting changes | ||
98 | varies by component: | ||
99 | |||
100 | - *Core Metadata:* Send your patch to the | ||
101 | :oe_lists:`openembedded-core </g/openembedded-core>` | ||
102 | mailing list. For example, a change to anything under the ``meta`` or | ||
103 | ``scripts`` directories should be sent to this mailing list. | ||
104 | |||
105 | - *BitBake:* For changes to BitBake (i.e. anything under the | ||
106 | ``bitbake`` directory), send your patch to the | ||
107 | :oe_lists:`bitbake-devel </g/bitbake-devel>` | ||
108 | mailing list. | ||
109 | |||
110 | - *"meta-\*" trees:* These trees contain Metadata. Use the | ||
111 | :yocto_lists:`poky </g/poky>` mailing list. | ||
112 | |||
113 | - *Documentation*: For changes to the Yocto Project documentation, use the | ||
114 | :yocto_lists:`docs </g/docs>` mailing list. | ||
115 | |||
116 | For changes to other layers hosted in the Yocto Project source | ||
117 | repositories (i.e. ``yoctoproject.org``) and tools use the | ||
118 | :yocto_lists:`Yocto Project </g/yocto/>` general mailing list. | ||
119 | |||
120 | .. note:: | ||
121 | |||
122 | Sometimes a layer's documentation specifies to use a particular | ||
123 | mailing list. If so, use that list. | ||
124 | |||
125 | For additional recipes that do not fit into the core Metadata, you | ||
126 | should determine which layer the recipe should go into and submit the | ||
127 | change in the manner recommended by the documentation (e.g. the | ||
128 | ``README`` file) supplied with the layer. If in doubt, please ask on the | ||
129 | Yocto general mailing list or on the openembedded-devel mailing list. | ||
130 | |||
131 | You can also push a change upstream and request a maintainer to pull the | ||
132 | change into the component's upstream repository. You do this by pushing | ||
133 | to a contribution repository that is upstream. See the | ||
134 | ":ref:`overview-manual/development-environment:git workflows and the yocto project`" | ||
135 | section in the Yocto Project Overview and Concepts Manual for additional | ||
136 | concepts on working in the Yocto Project development environment. | ||
137 | |||
138 | Maintainers commonly use ``-next`` branches to test submissions prior to | ||
139 | merging patches. Thus, you can get an idea of the status of a patch based on | ||
140 | whether the patch has been merged into one of these branches. The commonly | ||
141 | used testing branches for OpenEmbedded-Core are as follows: | ||
142 | |||
143 | - *openembedded-core "master-next" branch:* This branch is part of the | ||
144 | :oe_git:`openembedded-core </openembedded-core/>` repository and contains | ||
145 | proposed changes to the core metadata. | ||
146 | |||
147 | - *poky "master-next" branch:* This branch is part of the | ||
148 | :yocto_git:`poky </poky/>` repository and combines proposed | ||
149 | changes to BitBake, the core metadata and the poky distro. | ||
150 | |||
151 | Similarly, stable branches maintained by the project may have corresponding | ||
152 | ``-next`` branches which collect proposed changes. For example, | ||
153 | ``&DISTRO_NAME_NO_CAP;-next`` and ``&DISTRO_NAME_NO_CAP_MINUS_ONE;-next`` | ||
154 | branches in both the "openembdedded-core" and "poky" repositories. | ||
155 | |||
156 | Other layers may have similar testing branches but there is no formal | ||
157 | requirement or standard for these so please check the documentation for the | ||
158 | layers you are contributing to. | ||
159 | |||
160 | The following sections provide procedures for submitting a change. | ||
161 | |||
162 | Preparing Changes for Submission | ||
163 | -------------------------------- | ||
164 | |||
165 | #. *Make Your Changes Locally:* Make your changes in your local Git | ||
166 | repository. You should make small, controlled, isolated changes. | ||
167 | Keeping changes small and isolated aids review, makes | ||
168 | merging/rebasing easier and keeps the change history clean should | ||
169 | anyone need to refer to it in future. | ||
170 | |||
171 | #. *Stage Your Changes:* Stage your changes by using the ``git add`` | ||
172 | command on each file you changed. | ||
173 | |||
174 | #. *Commit Your Changes:* Commit the change by using the ``git commit`` | ||
175 | command. Make sure your commit information follows standards by | ||
176 | following these accepted conventions: | ||
177 | |||
178 | - Be sure to include a "Signed-off-by:" line in the same style as | ||
179 | required by the Linux kernel. This can be done by using the | ||
180 | ``git commit -s`` command. Adding this line signifies that you, | ||
181 | the submitter, have agreed to the Developer's Certificate of | ||
182 | Origin 1.1 as follows: | ||
183 | |||
184 | .. code-block:: none | ||
185 | |||
186 | Developer's Certificate of Origin 1.1 | ||
187 | |||
188 | By making a contribution to this project, I certify that: | ||
189 | |||
190 | (a) The contribution was created in whole or in part by me and I | ||
191 | have the right to submit it under the open source license | ||
192 | indicated in the file; or | ||
193 | |||
194 | (b) The contribution is based upon previous work that, to the best | ||
195 | of my knowledge, is covered under an appropriate open source | ||
196 | license and I have the right under that license to submit that | ||
197 | work with modifications, whether created in whole or in part | ||
198 | by me, under the same open source license (unless I am | ||
199 | permitted to submit under a different license), as indicated | ||
200 | in the file; or | ||
201 | |||
202 | (c) The contribution was provided directly to me by some other | ||
203 | person who certified (a), (b) or (c) and I have not modified | ||
204 | it. | ||
205 | |||
206 | (d) I understand and agree that this project and the contribution | ||
207 | are public and that a record of the contribution (including all | ||
208 | personal information I submit with it, including my sign-off) is | ||
209 | maintained indefinitely and may be redistributed consistent with | ||
210 | this project or the open source license(s) involved. | ||
211 | |||
212 | - Provide a single-line summary of the change and, if more | ||
213 | explanation is needed, provide more detail in the body of the | ||
214 | commit. This summary is typically viewable in the "shortlist" of | ||
215 | changes. Thus, providing something short and descriptive that | ||
216 | gives the reader a summary of the change is useful when viewing a | ||
217 | list of many commits. You should prefix this short description | ||
218 | with the recipe name (if changing a recipe), or else with the | ||
219 | short form path to the file being changed. | ||
220 | |||
221 | - For the body of the commit message, provide detailed information | ||
222 | that describes what you changed, why you made the change, and the | ||
223 | approach you used. It might also be helpful if you mention how you | ||
224 | tested the change. Provide as much detail as you can in the body | ||
225 | of the commit message. | ||
226 | |||
227 | .. note:: | ||
228 | |||
229 | You do not need to provide a more detailed explanation of a | ||
230 | change if the change is minor to the point of the single line | ||
231 | summary providing all the information. | ||
232 | |||
233 | - If the change addresses a specific bug or issue that is associated | ||
234 | with a bug-tracking ID, include a reference to that ID in your | ||
235 | detailed description. For example, the Yocto Project uses a | ||
236 | specific convention for bug references --- any commit that addresses | ||
237 | a specific bug should use the following form for the detailed | ||
238 | description. Be sure to use the actual bug-tracking ID from | ||
239 | Bugzilla for bug-id:: | ||
240 | |||
241 | Fixes [YOCTO #bug-id] | ||
242 | |||
243 | detailed description of change | ||
244 | |||
245 | Using Email to Submit a Patch | ||
246 | ----------------------------- | ||
247 | |||
248 | Depending on the components changed, you need to submit the email to a | ||
249 | specific mailing list. For some guidance on which mailing list to use, | ||
250 | see the | ||
251 | :ref:`list <dev-manual/changes:submitting a change to the yocto project>` | ||
252 | at the beginning of this section. For a description of all the available | ||
253 | mailing lists, see the ":ref:`Mailing Lists <resources-mailinglist>`" section in the | ||
254 | Yocto Project Reference Manual. | ||
255 | |||
256 | Here is the general procedure on how to submit a patch through email | ||
257 | without using the scripts once the steps in | ||
258 | :ref:`dev-manual/changes:preparing changes for submission` have been followed: | ||
259 | |||
260 | #. *Format the Commit:* Format the commit into an email message. To | ||
261 | format commits, use the ``git format-patch`` command. When you | ||
262 | provide the command, you must include a revision list or a number of | ||
263 | patches as part of the command. For example, either of these two | ||
264 | commands takes your most recent single commit and formats it as an | ||
265 | email message in the current directory:: | ||
266 | |||
267 | $ git format-patch -1 | ||
268 | |||
269 | or :: | ||
270 | |||
271 | $ git format-patch HEAD~ | ||
272 | |||
273 | After the command is run, the current directory contains a numbered | ||
274 | ``.patch`` file for the commit. | ||
275 | |||
276 | If you provide several commits as part of the command, the | ||
277 | ``git format-patch`` command produces a series of numbered files in | ||
278 | the current directory – one for each commit. If you have more than | ||
279 | one patch, you should also use the ``--cover`` option with the | ||
280 | command, which generates a cover letter as the first "patch" in the | ||
281 | series. You can then edit the cover letter to provide a description | ||
282 | for the series of patches. For information on the | ||
283 | ``git format-patch`` command, see ``GIT_FORMAT_PATCH(1)`` displayed | ||
284 | using the ``man git-format-patch`` command. | ||
285 | |||
286 | .. note:: | ||
287 | |||
288 | If you are or will be a frequent contributor to the Yocto Project | ||
289 | or to OpenEmbedded, you might consider requesting a contrib area | ||
290 | and the necessary associated rights. | ||
291 | |||
292 | #. *Send the patches via email:* Send the patches to the recipients and | ||
293 | relevant mailing lists by using the ``git send-email`` command. | ||
294 | |||
295 | .. note:: | ||
296 | |||
297 | In order to use ``git send-email``, you must have the proper Git packages | ||
298 | installed on your host. | ||
299 | For Ubuntu, Debian, and Fedora the package is ``git-email``. | ||
300 | |||
301 | The ``git send-email`` command sends email by using a local or remote | ||
302 | Mail Transport Agent (MTA) such as ``msmtp``, ``sendmail``, or | ||
303 | through a direct ``smtp`` configuration in your Git ``~/.gitconfig`` | ||
304 | file. If you are submitting patches through email only, it is very | ||
305 | important that you submit them without any whitespace or HTML | ||
306 | formatting that either you or your mailer introduces. The maintainer | ||
307 | that receives your patches needs to be able to save and apply them | ||
308 | directly from your emails. A good way to verify that what you are | ||
309 | sending will be applicable by the maintainer is to do a dry run and | ||
310 | send them to yourself and then save and apply them as the maintainer | ||
311 | would. | ||
312 | |||
313 | The ``git send-email`` command is the preferred method for sending | ||
314 | your patches using email since there is no risk of compromising | ||
315 | whitespace in the body of the message, which can occur when you use | ||
316 | your own mail client. The command also has several options that let | ||
317 | you specify recipients and perform further editing of the email | ||
318 | message. For information on how to use the ``git send-email`` | ||
319 | command, see ``GIT-SEND-EMAIL(1)`` displayed using the | ||
320 | ``man git-send-email`` command. | ||
321 | |||
322 | The Yocto Project uses a `Patchwork instance <https://patchwork.yoctoproject.org/>`__ | ||
323 | to track the status of patches submitted to the various mailing lists and to | ||
324 | support automated patch testing. Each submitted patch is checked for common | ||
325 | mistakes and deviations from the expected patch format and submitters are | ||
326 | notified by patchtest if such mistakes are found. This process helps to | ||
327 | reduce the burden of patch review on maintainers. | ||
328 | |||
329 | .. note:: | ||
330 | |||
331 | This system is imperfect and changes can sometimes get lost in the flow. | ||
332 | Asking about the status of a patch or change is reasonable if the change | ||
333 | has been idle for a while with no feedback. | ||
334 | |||
335 | Using Scripts to Push a Change Upstream and Request a Pull | ||
336 | ---------------------------------------------------------- | ||
337 | |||
338 | For larger patch series it is preferable to send a pull request which not | ||
339 | only includes the patch but also a pointer to a branch that can be pulled | ||
340 | from. This involves making a local branch for your changes, pushing this | ||
341 | branch to an accessible repository and then using the ``create-pull-request`` | ||
342 | and ``send-pull-request`` scripts from openembedded-core to create and send a | ||
343 | patch series with a link to the branch for review. | ||
344 | |||
345 | Follow this procedure to push a change to an upstream "contrib" Git | ||
346 | repository once the steps in :ref:`dev-manual/changes:preparing changes for submission` have | ||
347 | been followed: | ||
348 | |||
349 | .. note:: | ||
350 | |||
351 | You can find general Git information on how to push a change upstream | ||
352 | in the | ||
353 | `Git Community Book <https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows>`__. | ||
354 | |||
355 | #. *Push Your Commits to a "Contrib" Upstream:* If you have arranged for | ||
356 | permissions to push to an upstream contrib repository, push the | ||
357 | change to that repository:: | ||
358 | |||
359 | $ git push upstream_remote_repo local_branch_name | ||
360 | |||
361 | For example, suppose you have permissions to push | ||
362 | into the upstream ``meta-intel-contrib`` repository and you are | ||
363 | working in a local branch named `your_name`\ ``/README``. The following | ||
364 | command pushes your local commits to the ``meta-intel-contrib`` | ||
365 | upstream repository and puts the commit in a branch named | ||
366 | `your_name`\ ``/README``:: | ||
367 | |||
368 | $ git push meta-intel-contrib your_name/README | ||
369 | |||
370 | #. *Determine Who to Notify:* Determine the maintainer or the mailing | ||
371 | list that you need to notify for the change. | ||
372 | |||
373 | Before submitting any change, you need to be sure who the maintainer | ||
374 | is or what mailing list that you need to notify. Use either these | ||
375 | methods to find out: | ||
376 | |||
377 | - *Maintenance File:* Examine the ``maintainers.inc`` file, which is | ||
378 | located in the :term:`Source Directory` at | ||
379 | ``meta/conf/distro/include``, to see who is responsible for code. | ||
380 | |||
381 | - *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can | ||
382 | enter the following command to bring up a short list of all | ||
383 | commits against a specific file:: | ||
384 | |||
385 | git shortlog -- filename | ||
386 | |||
387 | Just provide the name of the file for which you are interested. The | ||
388 | information returned is not ordered by history but does include a | ||
389 | list of everyone who has committed grouped by name. From the list, | ||
390 | you can see who is responsible for the bulk of the changes against | ||
391 | the file. | ||
392 | |||
393 | - *Examine the List of Mailing Lists:* For a list of the Yocto | ||
394 | Project and related mailing lists, see the ":ref:`Mailing | ||
395 | lists <resources-mailinglist>`" section in | ||
396 | the Yocto Project Reference Manual. | ||
397 | |||
398 | #. *Make a Pull Request:* Notify the maintainer or the mailing list that | ||
399 | you have pushed a change by making a pull request. | ||
400 | |||
401 | The Yocto Project provides two scripts that conveniently let you | ||
402 | generate and send pull requests to the Yocto Project. These scripts | ||
403 | are ``create-pull-request`` and ``send-pull-request``. You can find | ||
404 | these scripts in the ``scripts`` directory within the | ||
405 | :term:`Source Directory` (e.g. | ||
406 | ``poky/scripts``). | ||
407 | |||
408 | Using these scripts correctly formats the requests without | ||
409 | introducing any whitespace or HTML formatting. The maintainer that | ||
410 | receives your patches either directly or through the mailing list | ||
411 | needs to be able to save and apply them directly from your emails. | ||
412 | Using these scripts is the preferred method for sending patches. | ||
413 | |||
414 | First, create the pull request. For example, the following command | ||
415 | runs the script, specifies the upstream repository in the contrib | ||
416 | directory into which you pushed the change, and provides a subject | ||
417 | line in the created patch files:: | ||
418 | |||
419 | $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" | ||
420 | |||
421 | Running this script forms ``*.patch`` files in a folder named | ||
422 | ``pull-``\ `PID` in the current directory. One of the patch files is a | ||
423 | cover letter. | ||
424 | |||
425 | Before running the ``send-pull-request`` script, you must edit the | ||
426 | cover letter patch to insert information about your change. After | ||
427 | editing the cover letter, send the pull request. For example, the | ||
428 | following command runs the script and specifies the patch directory | ||
429 | and email address. In this example, the email address is a mailing | ||
430 | list:: | ||
431 | |||
432 | $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@lists.yoctoproject.org | ||
433 | |||
434 | You need to follow the prompts as the script is interactive. | ||
435 | |||
436 | .. note:: | ||
437 | |||
438 | For help on using these scripts, simply provide the ``-h`` | ||
439 | argument as follows:: | ||
440 | |||
441 | $ poky/scripts/create-pull-request -h | ||
442 | $ poky/scripts/send-pull-request -h | ||
443 | |||
444 | Responding to Patch Review | ||
445 | -------------------------- | ||
446 | |||
447 | You may get feedback on your submitted patches from other community members | ||
448 | or from the automated patchtest service. If issues are identified in your | ||
449 | patch then it is usually necessary to address these before the patch will be | ||
450 | accepted into the project. In this case you should amend the patch according | ||
451 | to the feedback and submit an updated version to the relevant mailing list, | ||
452 | copying in the reviewers who provided feedback to the previous version of the | ||
453 | patch. | ||
454 | |||
455 | The patch should be amended using ``git commit --amend`` or perhaps ``git | ||
456 | rebase`` for more expert git users. You should also modify the ``[PATCH]`` | ||
457 | tag in the email subject line when sending the revised patch to mark the new | ||
458 | iteration as ``[PATCH v2]``, ``[PATCH v3]``, etc as appropriate. This can be | ||
459 | done by passing the ``-v`` argument to ``git format-patch`` with a version | ||
460 | number. | ||
461 | |||
462 | Lastly please ensure that you also test your revised changes. In particular | ||
463 | please don't just edit the patch file written out by ``git format-patch`` and | ||
464 | resend it. | ||
465 | |||
466 | Submitting Changes to Stable Release Branches | ||
467 | --------------------------------------------- | ||
468 | |||
469 | The process for proposing changes to a Yocto Project stable branch differs | ||
470 | from the steps described above. Changes to a stable branch must address | ||
471 | identified bugs or CVEs and should be made carefully in order to avoid the | ||
472 | risk of introducing new bugs or breaking backwards compatibility. Typically | ||
473 | bug fixes must already be accepted into the master branch before they can be | ||
474 | backported to a stable branch unless the bug in question does not affect the | ||
475 | master branch or the fix on the master branch is unsuitable for backporting. | ||
476 | |||
477 | The list of stable branches along with the status and maintainer for each | ||
478 | branch can be obtained from the | ||
479 | :yocto_wiki:`Releases wiki page </Releases>`. | ||
480 | |||
481 | .. note:: | ||
482 | |||
483 | Changes will not typically be accepted for branches which are marked as | ||
484 | End-Of-Life (EOL). | ||
485 | |||
486 | With this in mind, the steps to submit a change for a stable branch are as | ||
487 | follows: | ||
488 | |||
489 | #. *Identify the bug or CVE to be fixed:* This information should be | ||
490 | collected so that it can be included in your submission. | ||
491 | |||
492 | See :ref:`dev-manual/vulnerabilities:checking for vulnerabilities` | ||
493 | for details about CVE tracking. | ||
494 | |||
495 | #. *Check if the fix is already present in the master branch:* This will | ||
496 | result in the most straightforward path into the stable branch for the | ||
497 | fix. | ||
498 | |||
499 | #. *If the fix is present in the master branch --- submit a backport request | ||
500 | by email:* You should send an email to the relevant stable branch | ||
501 | maintainer and the mailing list with details of the bug or CVE to be | ||
502 | fixed, the commit hash on the master branch that fixes the issue and | ||
503 | the stable branches which you would like this fix to be backported to. | ||
504 | |||
505 | #. *If the fix is not present in the master branch --- submit the fix to the | ||
506 | master branch first:* This will ensure that the fix passes through the | ||
507 | project's usual patch review and test processes before being accepted. | ||
508 | It will also ensure that bugs are not left unresolved in the master | ||
509 | branch itself. Once the fix is accepted in the master branch a backport | ||
510 | request can be submitted as above. | ||
511 | |||
512 | #. *If the fix is unsuitable for the master branch --- submit a patch | ||
513 | directly for the stable branch:* This method should be considered as a | ||
514 | last resort. It is typically necessary when the master branch is using | ||
515 | a newer version of the software which includes an upstream fix for the | ||
516 | issue or when the issue has been fixed on the master branch in a way | ||
517 | that introduces backwards incompatible changes. In this case follow the | ||
518 | steps in :ref:`dev-manual/changes:preparing changes for submission` and | ||
519 | :ref:`dev-manual/changes:using email to submit a patch` but modify the subject header of your patch | ||
520 | email to include the name of the stable branch which you are | ||
521 | targetting. This can be done using the ``--subject-prefix`` argument to | ||
522 | ``git format-patch``, for example to submit a patch to the dunfell | ||
523 | branch use | ||
524 | ``git format-patch --subject-prefix='&DISTRO_NAME_NO_CAP_MINUS_ONE;][PATCH' ...``. | ||
525 | |||
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 3c5609cef5..fea2cb30a1 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst | |||
@@ -879,8 +879,7 @@ The build should work without issue. | |||
879 | As with all solved problems, if they originated upstream, you need to | 879 | As with all solved problems, if they originated upstream, you need to |
880 | submit the fix for the recipe in OE-Core and upstream so that the | 880 | submit the fix for the recipe in OE-Core and upstream so that the |
881 | problem is taken care of at its source. See the | 881 | problem is taken care of at its source. See the |
882 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 882 | ":doc:`../contributor-guide/submit-changes`" section for more information. |
883 | section for more information. | ||
884 | 883 | ||
885 | Debugging With the GNU Project Debugger (GDB) Remotely | 884 | Debugging With the GNU Project Debugger (GDB) Remotely |
886 | ====================================================== | 885 | ====================================================== |
@@ -1236,9 +1235,7 @@ Here are some other tips that you might find useful: | |||
1236 | :yocto_bugs:`Bugzilla <>`. For information on | 1235 | :yocto_bugs:`Bugzilla <>`. For information on |
1237 | how to submit a bug against the Yocto Project, see the Yocto Project | 1236 | how to submit a bug against the Yocto Project, see the Yocto Project |
1238 | Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 1237 | Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
1239 | and the | 1238 | and the ":doc:`../contributor-guide/report-defect`" section. |
1240 | ":ref:`dev-manual/changes:submitting a defect against the yocto project`" | ||
1241 | section. | ||
1242 | 1239 | ||
1243 | .. note:: | 1240 | .. note:: |
1244 | 1241 | ||
diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst index b0bb5576ad..3618e51c8d 100644 --- a/documentation/dev-manual/index.rst +++ b/documentation/dev-manual/index.rst | |||
@@ -43,7 +43,6 @@ Yocto Project Development Tasks Manual | |||
43 | build-quality | 43 | build-quality |
44 | runtime-testing | 44 | runtime-testing |
45 | debugging | 45 | debugging |
46 | changes | ||
47 | licenses | 46 | licenses |
48 | vulnerabilities | 47 | vulnerabilities |
49 | sbom | 48 | sbom |
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 4881481044..88afa27ad5 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -246,14 +246,13 @@ particular working environment and set of practices. | |||
246 | - The Yocto Project community encourages you to send patches to the | 246 | - The Yocto Project community encourages you to send patches to the |
247 | project to fix bugs or add features. If you do submit patches, | 247 | project to fix bugs or add features. If you do submit patches, |
248 | follow the project commit guidelines for writing good commit | 248 | follow the project commit guidelines for writing good commit |
249 | messages. See the | 249 | messages. See the ":doc:`../contributor-guide/submit-changes`" |
250 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 250 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
251 | section. | ||
252 | 251 | ||
253 | - Send changes to the core sooner than later as others are likely | 252 | - Send changes to the core sooner than later as others are likely |
254 | to run into the same issues. For some guidance on mailing lists | 253 | to run into the same issues. For some guidance on mailing lists |
255 | to use, see the list in the | 254 | to use, see the lists in the |
256 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 255 | ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" |
257 | section. For a description | 256 | section. For a description |
258 | of the available mailing lists, see the ":ref:`resources-mailinglist`" section in | 257 | of the available mailing lists, see the ":ref:`resources-mailinglist`" section in |
259 | the Yocto Project Reference Manual. | 258 | the Yocto Project Reference Manual. |
diff --git a/documentation/dev-manual/vulnerabilities.rst b/documentation/dev-manual/vulnerabilities.rst index 0ee3ec52c5..ac0ca249c1 100644 --- a/documentation/dev-manual/vulnerabilities.rst +++ b/documentation/dev-manual/vulnerabilities.rst | |||
@@ -22,7 +22,7 @@ issues may be impacting Poky and OE-Core. It is up to the maintainers, users, | |||
22 | contributors and anyone interested in the issues to investigate and possibly fix them by | 22 | contributors and anyone interested in the issues to investigate and possibly fix them by |
23 | updating software components to newer versions or by applying patches to address them. | 23 | updating software components to newer versions or by applying patches to address them. |
24 | It is recommended to work with Poky and OE-Core upstream maintainers and submit | 24 | It is recommended to work with Poky and OE-Core upstream maintainers and submit |
25 | patches to fix them, see ":ref:`dev-manual/changes:submitting a change to the yocto project`" for details. | 25 | patches to fix them, see ":doc:`../contributor-guide/submit-changes`" for details. |
26 | 26 | ||
27 | Vulnerability check at build time | 27 | Vulnerability check at build time |
28 | ================================= | 28 | ================================= |
diff --git a/documentation/index.rst b/documentation/index.rst index 6335c707e0..3fef1704a4 100644 --- a/documentation/index.rst +++ b/documentation/index.rst | |||
@@ -26,6 +26,7 @@ Welcome to the Yocto Project Documentation | |||
26 | :caption: Manuals | 26 | :caption: Manuals |
27 | 27 | ||
28 | Overview and Concepts Manual <overview-manual/index> | 28 | Overview and Concepts Manual <overview-manual/index> |
29 | Contributor Guide <contributor-guide/index> | ||
29 | Reference Manual <ref-manual/index> | 30 | Reference Manual <ref-manual/index> |
30 | Board Support Package (BSP) Developer's guide <bsp-guide/index> | 31 | Board Support Package (BSP) Developer's guide <bsp-guide/index> |
31 | Development Tasks Manual <dev-manual/index> | 32 | Development Tasks Manual <dev-manual/index> |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 6139e7a412..262d5cb203 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -232,8 +232,8 @@ and so forth. | |||
232 | 232 | ||
233 | For information on finding out who is responsible for (maintains) a | 233 | For information on finding out who is responsible for (maintains) a |
234 | particular area of code in the Yocto Project, see the | 234 | particular area of code in the Yocto Project, see the |
235 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 235 | ":doc:`../contributor-guide/identify-component`" |
236 | section of the Yocto Project Development Tasks Manual. | 236 | section of the Yocto Project and OpenEmbedded Contributor Guide. |
237 | 237 | ||
238 | The Yocto Project ``poky`` Git repository also has an upstream | 238 | The Yocto Project ``poky`` Git repository also has an upstream |
239 | contribution Git repository named ``poky-contrib``. You can see all the | 239 | contribution Git repository named ``poky-contrib``. You can see all the |
@@ -264,8 +264,8 @@ push them into the "contrib" area and subsequently request that the | |||
264 | maintainer include them into an upstream branch. This process is called | 264 | maintainer include them into an upstream branch. This process is called |
265 | "submitting a patch" or "submitting a change." For information on | 265 | "submitting a patch" or "submitting a change." For information on |
266 | submitting patches and changes, see the | 266 | submitting patches and changes, see the |
267 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 267 | ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project |
268 | section in the Yocto Project Development Tasks Manual. | 268 | and OpenEmbedded Contributor Guide. |
269 | 269 | ||
270 | In summary, there is a single point of entry for changes into the | 270 | In summary, there is a single point of entry for changes into the |
271 | development branch of the Git repository, which is controlled by the | 271 | development branch of the Git repository, which is controlled by the |
@@ -328,11 +328,10 @@ Book <https://book.git-scm.com>`__. | |||
328 | software on which to develop. The Yocto Project has two scripts named | 328 | software on which to develop. The Yocto Project has two scripts named |
329 | ``create-pull-request`` and ``send-pull-request`` that ship with the | 329 | ``create-pull-request`` and ``send-pull-request`` that ship with the |
330 | release to facilitate this workflow. You can find these scripts in | 330 | release to facilitate this workflow. You can find these scripts in |
331 | the ``scripts`` folder of the | 331 | the ``scripts`` folder of the :term:`Source Directory`. For information |
332 | :term:`Source Directory`. For information | ||
333 | on how to use these scripts, see the | 332 | on how to use these scripts, see the |
334 | ":ref:`dev-manual/changes:using scripts to push a change upstream and request a pull`" | 333 | ":ref:`contributor-guide/submit-changes:using scripts to push a change upstream and request a pull`" |
335 | section in the Yocto Project Development Tasks Manual. | 334 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
336 | 335 | ||
337 | - *Patch Workflow:* This workflow allows you to notify the maintainer | 336 | - *Patch Workflow:* This workflow allows you to notify the maintainer |
338 | through an email that you have a change (or patch) you would like | 337 | through an email that you have a change (or patch) you would like |
@@ -340,8 +339,8 @@ Book <https://book.git-scm.com>`__. | |||
340 | this type of change, you format the patch and then send the email | 339 | this type of change, you format the patch and then send the email |
341 | using the Git commands ``git format-patch`` and ``git send-email``. | 340 | using the Git commands ``git format-patch`` and ``git send-email``. |
342 | For information on how to use these scripts, see the | 341 | For information on how to use these scripts, see the |
343 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" | 342 | ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project |
344 | section in the Yocto Project Development Tasks Manual. | 343 | and OpenEmbedded Contributor Guide. |
345 | 344 | ||
346 | Git | 345 | Git |
347 | === | 346 | === |
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index d2344e39a0..8c3726e83b 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -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/changes: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 | ||
@@ -46,8 +45,8 @@ your expectations). | |||
46 | For a general procedure and guidelines on how to use Bugzilla to submit a bug | 45 | For a general procedure and guidelines on how to use Bugzilla to submit a bug |
47 | against the Yocto Project, see the following: | 46 | against the Yocto Project, see the following: |
48 | 47 | ||
49 | - The ":ref:`dev-manual/changes:submitting a defect against the yocto project`" | 48 | - The ":doc:`../contributor-guide/report-defect`" |
50 | section in the Yocto Project Development Tasks Manual. | 49 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
51 | 50 | ||
52 | - 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>` |
53 | 52 | ||
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index fe6de4b3da..e1ff51c859 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -134,9 +134,8 @@ tested on former revisions of "&DISTRO_NAME;", but no longer are: | |||
134 | interested in hearing about your experience. For information on | 134 | interested in hearing about your experience. For information on |
135 | how to submit a bug, see the Yocto Project | 135 | how to submit a bug, see the Yocto Project |
136 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 136 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
137 | and the ":ref:`dev-manual/changes:submitting a defect against the yocto project`" | 137 | and the ":doc:`../contributor-guide/report-defect`" |
138 | section in the Yocto Project Development Tasks Manual. | 138 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
139 | |||
140 | 139 | ||
141 | Required Packages for the Build Host | 140 | Required Packages for the Build Host |
142 | ==================================== | 141 | ==================================== |