[OpenOCD-commit] Main OpenOCD repository branch, master, updated. v0.12.0-733-g017e61feb

[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  017e61feb44b71ac013ae4c7f2cfa3e7ca3323ae (commit)
      from  8edfdb02ed1fd73568ef9e9522634e65791dbd69 (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 017e61feb44b71ac013ae4c7f2cfa3e7ca3323ae
Author: Antonio Borneo <bor...@gm...>
Date:   Sun Apr 2 20:47:41 2023 +0200

    HACKING: add info on ignoring check-patch checks
    
    Due to checkpatch internal state machine, the field 'Checkpatch-ignore:'
    must be in the commit message before the 'Signed-off-by:' line.
    Report it in the documentation and add that multiple 'Checkpatch-ignore:'
    lines are allowed.
    
    Change-Id: I770cdc4cb5b33bcf63c860c154ab3cbd4785ad20
    Signed-off-by: Antonio Borneo <bor...@gm...>
    Reviewed-on: https://review.openocd.org/c/openocd/+/7572
    Tested-by: jenkins

diff --git a/HACKING b/HACKING
index 74cbe02e7..9e8cd357f 100644
--- a/HACKING
+++ b/HACKING
@@ -287,6 +287,13 @@ Only for <em>exceptional cases</em>, it is allowed to submit patches
 to Gerrit with the special field 'Checkpatch-ignore:' in the commit
 message. This field will cause checkpatch to ignore the error types
 listed in the field, only for the patch itself.
+For errors in the commit message, the special field has to be put in
+the commit message before the line that produces the error.
+The special field must be added <em>before</em> the 'Signed-off-by:'
+line, otherwise it is ignored.
+To ignore multiple errors, either add multiple lines with the special
+field or add multiple error types, separated by space or commas, in a
+single line.
 The error type is printed by checkpatch on failure.
 For example the names of Windows APIs mix lower and upper case chars,
 in violation of OpenOCD coding style, triggering a 'CAMELCASE' error:

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

Summary of changes:
 HACKING | 7 +++++++
 1 file changed, 7 insertions(+)


hooks/post-receive
-- 
Main OpenOCD repository