linux/poky.git/documentation/contributor-guide, branch yocto-5.2.4

contributor-guide/submit-changes: encourage patch version changelogs

2025-05-19T15:57:20+00:00

Add a section after the 'git format-patch' information encouraging developers to add patch version changelogs to their patch updates. (From yocto-docs rev: dff4d470193c1b5c961f4725b796050fb79b2b5c) Signed-off-by: Trevor Woerner Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 2e3a37c4607b296956993e557d1786c4876e5722) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide/submit-changes: add policy on AI generated code

2025-02-18T15:47:37+00:00

Based on message by Richard Purdie on the yocto-docs list: https://lists.yoctoproject.org/g/docs/message/6300 Re-formatted for the Yocto Project documentation syntax. (From yocto-docs rev: a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide/submit-changes.rst: suggest to remove the git signature

2025-01-09T13:58:17+00:00

By default when sending patches Git adds the git version at the bottom of the patch, which is not necessary in most cases. Suggest to remove it when configuring Git when sending patches. Suggested-By: Jaekyu Lee (From yocto-docs rev: d3465691231f10466703198a831a681803ffdfad) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

Update the documentation for SRCPV

2024-12-20T12:47:59+00:00

The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: Remove duplicated words

2024-11-12T11:09:51+00:00

Remove "and then" as it is duplicated. (From yocto-docs rev: 90666b8c85fe6afaf102034ebcd5d25d8391e697) Signed-off-by: Talel BELHAJSALEM Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

conf.py: rename :cve: role to :cve_nist:

2024-11-07T10:12:23+00:00

Newer versions of Sphinx already define a :cve: role that points to cve.org, instead of the role we defined in conf.py that points to nvd.nist.gov. Rename our role to :cve_nist: to avoid warnings (treated as errors). This is also backwards compatible, meaning we can build the doc with an older Sphinx if needed. The file were automatically replaced with following command: find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+ Suggested-By: Quentin Schulz Reviewed-by: Quentin Schulz (From yocto-docs rev: 15fa3b7e85dde50d7236c1738ad607531cc654b8) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

recipe style guide: add recommendation for patches without signature

2024-06-16T21:48:18+00:00

>From discussion [0], the presence of git version signature at the end of patches has been questionned. To avoid a bit more noise, the setting git format.signature is added to the documentation and its use is recommended. [0]: https://lists.openembedded.org/g/openembedded-core/topic/106323318#msg199967 (From yocto-docs rev: 7da39b91a0f20cb7215d51e00c098f3dc13180fd) Signed-off-by: Alexandre Truong Reviewed-by: Yoann Congal Reviewed-by: Michael Opdenacker Signed-off-by: Alexandre Belloni Signed-off-by: Richard Purdie

manuals: refer to new yocto-patches mailing list wherever appropriate

2024-04-08T13:36:38+00:00

There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 Cc: Quentin Schulz (From yocto-docs rev: ac512f76b93a20507a6835ddafa954b4ae45e268) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

contributor-guide: be more specific about meta-* trees

2024-03-19T15:22:27+00:00

* this is often confused to apply for e.g. meta-oe as well where it doesn't apply as meta-oe has own ML mentioned in README. (From yocto-docs rev: 63be0814a7ecf38c570b6d776f62b7c7803eb299) Signed-off-by: Martin Jansa Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

contributor-guide: add notes for tests

2024-03-06T16:54:54+00:00

This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] (From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146) Signed-off-by: Simone Weiß Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie