diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-08-11 19:48:33 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-08-30 15:54:59 +0100 |
commit | 9bf8250a403e046a0cbd4bea7113b03b33b27cc0 (patch) | |
tree | ea8cdebffe5789ec78635b170fad8013518b307d /documentation/dev-manual | |
parent | 82533714c148955d4d0bd08e82407c44b3a1f8ae (diff) | |
download | poky-9bf8250a403e046a0cbd4bea7113b03b33b27cc0.tar.gz |
contributor guide: update instructions for making and sharing changes
- Shifting the focus to multiple changes instead of just one
- Advising to create a branch for changes
- Removing unnecessary or too verbose explanations
- Adding useful resources and examples
(From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/debugging.rst | 2 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 4 | ||||
-rw-r--r-- | documentation/dev-manual/vulnerabilities.rst | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index 890578cc05..fea2cb30a1 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst | |||
@@ -879,7 +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 | ":doc:`../contributor-guide/submit-change`" section for more information. | 882 | ":doc:`../contributor-guide/submit-changes`" section for more information. |
883 | 883 | ||
884 | Debugging With the GNU Project Debugger (GDB) Remotely | 884 | Debugging With the GNU Project Debugger (GDB) Remotely |
885 | ====================================================== | 885 | ====================================================== |
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 372959d9ed..88afa27ad5 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -246,13 +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 ":doc:`../contributor-guide/submit-change`" | 249 | messages. See the ":doc:`../contributor-guide/submit-changes`" |
250 | section in the Yocto Project and OpenEmbedded Contributor Guide. | 250 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
251 | 251 | ||
252 | - 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 |
253 | 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 |
254 | to use, see the lists in the | 254 | to use, see the lists in the |
255 | ":ref:`contributor-guide/submit-change:finding a suitable mailing list`" | 255 | ":ref:`contributor-guide/submit-changes:finding a suitable mailing list`" |
256 | section. For a description | 256 | section. For a description |
257 | 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 |
258 | 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 297789dae6..71111bb3e2 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 ":doc:`../contributor-guide/submit-change`" 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 | ================================= |