summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@cherry.de>2025-09-18 12:24:40 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-09-26 16:40:40 +0100
commited3ed8db2e331a63d06a757e16af5d7d2930bd63 (patch)
tree1b9a6fca1f886ade545ba28fb189eaa44f67b07c
parent2eb489092cec3af8e7da6bf648a438fc92160e1b (diff)
downloadpoky-ed3ed8db2e331a63d06a757e16af5d7d2930bd63.tar.gz
contributor-guide: submit-changes: clarify example with Yocto bug ID
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 <barne.carstensen@danfoss.com> (From yocto-docs rev: a5862406bf3230befe9db9f2539bbbc86c02015d) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/contributor-guide/submit-changes.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index e1215a5550..35da2dbc70 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -198,6 +198,8 @@ to add the upgraded version.
198 description. Be sure to use the actual bug-tracking ID from 198 description. Be sure to use the actual bug-tracking ID from
199 Bugzilla for bug-id:: 199 Bugzilla for bug-id::
200 200
201 single-line summary of change
202
201 Fixes [YOCTO #bug-id] 203 Fixes [YOCTO #bug-id]
202 204
203 detailed description of change 205 detailed description of change