diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-08-02 16:01:13 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-08-30 15:54:59 +0100 |
commit | 8a11abf6a9dac76bf9739c44102a49984e3c2977 (patch) | |
tree | e9fad45beb65d1330dad49408de14cd164820bd4 /documentation/contributor-guide/identify-component.rst | |
parent | ddf3b3ecd4b1680dc0dedfd4eaebcf3441b14ca7 (diff) | |
download | poky-8a11abf6a9dac76bf9739c44102a49984e3c2977.tar.gz |
manuals: create a dedicated "Contributor Guide" document
Starting from the original contents of dev-manual/changes.rst
and from text contributed by Richard Purdie.
(From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/contributor-guide/identify-component.rst')
-rw-r--r-- | documentation/contributor-guide/identify-component.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/documentation/contributor-guide/identify-component.rst b/documentation/contributor-guide/identify-component.rst new file mode 100644 index 0000000000..ba7c998888 --- /dev/null +++ b/documentation/contributor-guide/identify-component.rst | |||
@@ -0,0 +1,29 @@ | |||
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 (``bitbake``, ``openembedded-core``, | ||
26 | ``meta-yocto`` and ``yocto-docs``). Patches should be submitted against | ||
27 | the appropriate individual component rather than :term:`Poky` itself as | ||
28 | detailed in the appropriate ``README`` file. | ||
29 | |||