doc: prevent writing "topic:" to commit message 83/6683/4 master
authorTomas Vanek <>
Tue, 9 Nov 2021 18:22:29 +0000 (19:22 +0100)
committerTomas Vanek <>
Tue, 17 May 2022 14:39:05 +0000 (14:39 +0000)
First time contributors surprisingly often write "topic:"
instead of "the main part or subsystem the patch touches" as requested
in patchguide.html

To prevent them doing so:
Use longer self-explaing "specify touched area" instead of "topic"
Give some examples in addition to recommended looking at "git log"

Change-Id: I1c307b460d7a79ba3c9918af8dbc9e9f827e1fb9
Signed-off-by: Tomas Vanek <>
Reviewed-by: Antonio Borneo <>
Tested-by: Paul Fertser <>

diff --git a/HACKING b/HACKING
index cf3f58906064381952c45a52c9494faf8a0aa5ce..96b05f2d62b20e41818726e977ce406743f68069 100644 (file)
@@ -171,11 +171,11 @@ while(!done) {
    \note use "git add ." before commit to add new files.
-   Comment template, notice the short first line w/topic. The topic field
-   should identify the main part or subsystem the patch touches. Check
-   git log for examples.
-topic: Short comment
+   Commit message template, notice the short first line.
+   The field '<c>specify touched area</c>'
+   should identify the main part or subsystem the patch touches.
+specify touched area: short comment
 <blank line>
 Longer comments over several lines, explaining (where applicable) the
 reason for the patch and the general idea the solution is based on,
@@ -183,6 +183,32 @@ any major design decisions, etc...
 <blank line>
 Signed-off-by: ...
+   Examples:
+flash/nor/atsame5: add SAME59 support
+Add new device ID
+flash/nor: flash driver for XYZ123
+Add new flash driver for internal flash of ...
+target/cortex_m: fix segmentation fault in cmd 'soft_reset_halt'
+soft_reset_halt command failed reproducibly under following conditions: ...
+Test for NULL pointer and return error ...
+Reported-by: John Reporter <>
+Fixes: 123456789abc ("target: the commit where the problem started")
+doc: fix typos
+   See "git log" for more examples.
 -# Next you need to make sure that your patches
    are on top of the latest stuff on the server and
    that there are no conflicts:

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 (RSA)