summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide/identify-component.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-09-06 10:26:32 +0200
committerSteve Sakoman <steve@sakoman.com>2023-09-13 06:21:26 -1000
commit1c54f85cf94919a56cb2a106d8931f2e3dea160c (patch)
tree13b1a6487d4018eb5777e0e5580134c7eea9896c /documentation/contributor-guide/identify-component.rst
parentca4a09f897f71d9d4a414ad8549a583a25f87b6a (diff)
downloadpoky-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/contributor-guide/identify-component.rst')
-rw-r--r--documentation/contributor-guide/identify-component.rst31
1 files changed, 31 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..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
3Identify the component
4**********************
5
6The Yocto Project and OpenEmbedded ecosystem is built of :term:`layers <Layer>`
7so the first step is to identify the component where the issue likely lies.
8For example, if you have a hardware issue, it is likely related to the BSP
9you are using and the best place to seek advice would be from the BSP provider
10or :term:`layer`. If the issue is a build/configuration one and a distro is in
11use, they would likely be the first place to ask questions. If the issue is a
12generic one and/or in the core classes or metadata, the core layer or BitBake
13might be the appropriate component.
14
15Each metadata layer being used should contain a ``README`` file and that should
16explain where to report issues, where to send changes and how to contact the
17maintainers.
18
19If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake,
20issues 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
22where 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
25components 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
29appropriate individual component rather than :term:`Poky` itself as detailed in
30the appropriate ``README`` file.
31