This is an automated email from Gerrit. "Tomas Vanek <[email protected]>" just uploaded a new patch set to Gerrit, which you can find at https://review.openocd.org/c/openocd/+/6683
-- gerrit commit 68b761c3df2a0f3256ea97934cd07da1ff9f750f Author: Tomas Vanek <[email protected]> Date: Tue Nov 9 19:22:29 2021 +0100 doc: prevent writing "topic:" to commit message 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 <[email protected]> diff --git a/HACKING b/HACKING index cf3f58906..fc6582f08 100644 --- a/HACKING +++ b/HACKING @@ -171,11 +171,11 @@ while(!done) { @endcode \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. + Commit message template, notice the short first line. + The field <em>'Specify touched area'</em> + should identify the main part or subsystem the patch touches. @code -topic: Short comment +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,31 @@ any major design decisions, etc... <blank line> Signed-off-by: ... @endcode + Examples: +@code +flash/nor/atsame5: add SAME59 support + +Add new device ID +@endcode +@code +flash/nor: flash driver for XYZ123 + +Add new flash driver for internal flash of ... +@endcode +@code +target: fix segmentation fault in cmd 'mdq' + +mdq command failed reproducibly under following conditions: ... + +Reported-by: John Reporter <[email protected]> +Fixes: 123456789abc (target: the commit where the problem started) +Closes-Bug: https://sourceforge.net/p/openocd/tickets/999/ +@endcode +@code +doc: fix typos +@endcode + 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: --
