[OpenOCD-commit] Main OpenOCD repository branch, master, updated. v0.11.0-686-g4d1b29313

[OpenOCD-Gerrit <ope...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Main OpenOCD repository".

The branch, master has been updated
       via  4d1b29313ace5b26687f75fb132c04f91cc1edcb (commit)
      from  830d70bfc66ada2a68c73283b9e4fa4770d408ee (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 4d1b29313ace5b26687f75fb132c04f91cc1edcb
Author: Tomas Vanek <va...@fb...>
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 <va...@fb...>
    Reviewed-on: https://review.openocd.org/c/openocd/+/6683
    Reviewed-by: Antonio Borneo <bor...@gm...>
    Tested-by: Paul Fertser <fer...@gm...>

diff --git a/HACKING b/HACKING
index cf3f58906..96b05f2d6 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.
-@code
-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.
+@code{.unparsed}
+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: ...
 @endcode
+   Examples:
+@code{.unparsed}
+flash/nor/atsame5: add SAME59 support
+
+Add new device ID
+@endcode
+@code{.unparsed}
+flash/nor: flash driver for XYZ123
+
+Add new flash driver for internal flash of ...
+@endcode
+@code{.unparsed}
+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 <re...@gm...>
+Fixes: 123456789abc ("target: the commit where the problem started")
+BugLink: https://sourceforge.net/p/openocd/tickets/999/
+@endcode
+@code{.unparsed}
+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:

-----------------------------------------------------------------------

Summary of changes:
 HACKING | 36 +++++++++++++++++++++++++++++++-----
 1 file changed, 31 insertions(+), 5 deletions(-)


hooks/post-receive
-- 
Main OpenOCD repository