linux/poky.git/documentation/contributor-guide/submit-changes.rst, branch master-next

contributor-guide: submit-changes: make "Crediting contributors" part of "Commit your changes"

2025-09-26T15:40:40+00:00

There's no need to differentiate crediting contributors from committing your changes, so let's simply make it the last step of "Commit your changes" section. This simply indents the text so it's now part of "Commit your changes" list instead of the main list in the "Implement and commit changes" section. Because of this reorganisation, the instruction to use "git commit --amend" to add the contributors is moved to a note, and the first few sentences are reworded to better match the wording of other items in the "Commit your changes" list of instructions. (From yocto-docs rev: eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: submit-changes: number instruction list in commit your changes

2025-09-26T15:40:40+00:00

... so that it's clear that you need to read and follow each and every instruction in this list. (From yocto-docs rev: c628a489f081925fabaabb5acac6752251150269) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: submit-changes: reword commit message instructions

2025-09-26T15:40:40+00:00

This should hopefully make it clearer what is expected from the contributor. This follows my understanding of git-commit(1)[1] where the following is a git commit message: """ git commit title git commit description """ I'm putting the "Fixes [YOCTO" line in "body of the commit message" so it's understood as being different from the git commit description so that the note admonition allowing us to have an empty commit description doesn't apply to the "Fixes [YOCTO" line. [1] https://www.man7.org/linux/man-pages/man1/git-commit.1.html#DISCUSSION (From yocto-docs rev: b84903a760350bd118c56ea9ce4e98039edf6e55) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: submit-changes: make the Cc tag follow kernel guidelines

2025-09-26T15:40:40+00:00

The kernel docs specifies[1] a Cc: tag and not CC: tag, so let's align with that. [1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by (From yocto-docs rev: f800fef4e9e2c1d3584ac49be8324638d2923b17) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: submit-changes: align CC tag description

2025-09-26T15:40:40+00:00

The other tag descriptions have the double colon outside of the highlight, and start the sentence with a lowercase word, so let's align the CC tag with those. (From yocto-docs rev: f116e93fb335e9d0f85891c4cb501bcf55b18ccf) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: submit-changes: clarify example with Yocto bug ID

2025-09-26T15:40:40+00:00

The example could be understood as the content of the commit message once the editor (git config core.editor) opens, where the first line is the actual commit title and not the commit description. This example would make the Fixes line the commit title, which is not what we want. In short, according to my understanding of git-commit(1): The following is a git commit message: """ git commit title git commit description """ Reported-by: Barne Carstensen (From yocto-docs rev: a5862406bf3230befe9db9f2539bbbc86c02015d) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

contributor-guide: submit-changes: fix improper bold string

2025-09-26T15:40:40+00:00

I don't know what was the initial intent but this doesn't seem right, so let's remove the bold formatting. Fixes: 4abe87cb20d3 ("contributor-guide: submit-changes: detail commit and patch creation") Cc: Michael Opdenacker (From yocto-docs rev: 6c499b3796a578a0fe4c319c9547b4321b0d41df) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

tree-wide: make the :doc: directive use absolute paths

2025-06-20T08:48:15+00:00

This makes all :doc: directives use an absolute paths (with the root directory being documentation/ in the repo). This is then consistent across the whole source and is easier to review and move files around, you just need to know where a file is located relative to documentation/ directory and use that. This gets rid of paths looking in parent directory with '..' as well as expecting a file to be in the same directory as the other file it points to via the :doc: directive. (From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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

2025-05-19T14:54:10+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: 2e3a37c4607b296956993e557d1786c4876e5722) Signed-off-by: Trevor Woerner Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

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