[PATCH] doc/coding-style: Update URL to kernel coding style

[PATCH] doc/coding-style: Update URL to kernel coding style

[Michael Brudevold]

From: Michael Brudevold <michael.brudevold@veranexsolutions.com>

---
 doc/coding-style.txt | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/doc/coding-style.txt b/doc/coding-style.txt
index f0bf880e3..e73158840 100644
--- a/doc/coding-style.txt
+++ b/doc/coding-style.txt
@@ -7,14 +7,14 @@ some level of consistency among developers so that code can be easily
 understood and maintained.
 
 First of all, BlueZ coding style must follow every rule for Linux kernel
-(http://www.kernel.org/doc/Documentation/CodingStyle). There also exists a tool
-named checkpatch.pl to help you check the compliance with it. Just type
-"checkpatch.pl --no-tree patch_name" to check your patch. In theory, you need
-to clean up all the warnings and errors except this one: "ERROR: Missing
-Signed-off-by: line(s)". BlueZ does not used Signed-Off lines, so including
-them is actually an error.  In certain circumstances one can ignore the 80
-character per line limit.  This is generally only allowed if the alternative
-would make the code even less readable.
+(https://www.kernel.org/doc/Documentation/process/coding-style.rst). There also
+exists a tool named checkpatch.pl to help you check the compliance with it.
+Just type "checkpatch.pl --no-tree patch_name" to check your patch. In theory,
+you need to clean up all the warnings and errors except this one: "ERROR:
+Missing Signed-off-by: line(s)". BlueZ does not used Signed-Off lines, so
+including them is actually an error.  In certain circumstances one can ignore
+the 80 character per line limit.  This is generally only allowed if the
+alternative would make the code even less readable.
 
 Besides the kernel coding style above, BlueZ has special flavors for its own.
 Some of them are mandatory (marked as 'M'), while some others are optional
-- 
2.25.1

RE: doc/coding-style: Update URL to kernel coding style

[bluez.test.bot]

[-- Attachment #1: Type: text/plain, Size: 2183 bytes --]

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=647329

---Test result---

Test Summary:
CheckPatch                    FAIL      1.41 seconds
GitLint                       PASS      0.96 seconds
Prep - Setup ELL              PASS      40.26 seconds
Build - Prep                  PASS      0.68 seconds
Build - Configure             PASS      7.98 seconds
Build - Make                  PASS      1210.43 seconds
Make Check                    PASS      11.64 seconds
Make Check w/Valgrind         PASS      405.55 seconds
Make Distcheck                PASS      222.88 seconds
Build w/ext ELL - Configure   PASS      8.39 seconds
Build w/ext ELL - Make        PASS      1183.08 seconds
Incremental Build with patchesPASS      0.00 seconds

Details
##############################
Test: CheckPatch - FAIL
Desc: Run checkpatch.pl script with rule in .checkpatch.conf
Output:
doc/coding-style: Update URL to kernel coding style
WARNING:BAD_SIGN_OFF: '-signed-off-by:' is the preferred signature form
#95: FILE: doc/coding-style.txt:9:
-Signed-off-by: line(s)". BlueZ does not used Signed-Off lines, so including

ERROR:BAD_SIGN_OFF: Unrecognized email address: 'line(s)". BlueZ does not used Signed-Off lines, so including'
#95: FILE: doc/coding-style.txt:9:
-Signed-off-by: line(s)". BlueZ does not used Signed-Off lines, so including

/github/workspace/src/12869423.patch total: 1 errors, 1 warnings, 22 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

/github/workspace/src/12869423.patch has style problems, please review.

NOTE: Ignored message types: COMMIT_MESSAGE COMPLEX_MACRO CONST_STRUCT FILE_PATH_CHANGES MISSING_SIGN_OFF PREFER_PACKED SPDX_LICENSE_TAG SPLIT_STRING SSCANF_TO_KSTRTO

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.




---
Regards,
Linux Bluetooth

Re: doc/coding-style: Update URL to kernel coding style

[Luiz Augusto von Dentz]

Hi Tedd,

On Sun, Jun 5, 2022 at 5:31 AM <bluez.test.bot@gmail.com> wrote:
>
> This is automated email and please do not reply to this email!
>
> Dear submitter,
>
> Thank you for submitting the patches to the linux bluetooth mailing list.
> This is a CI test results with your patch series:
> PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=647329
>
> ---Test result---
>
> Test Summary:
> CheckPatch                    FAIL      1.41 seconds
> GitLint                       PASS      0.96 seconds
> Prep - Setup ELL              PASS      40.26 seconds
> Build - Prep                  PASS      0.68 seconds
> Build - Configure             PASS      7.98 seconds
> Build - Make                  PASS      1210.43 seconds
> Make Check                    PASS      11.64 seconds
> Make Check w/Valgrind         PASS      405.55 seconds
> Make Distcheck                PASS      222.88 seconds
> Build w/ext ELL - Configure   PASS      8.39 seconds
> Build w/ext ELL - Make        PASS      1183.08 seconds
> Incremental Build with patchesPASS      0.00 seconds
>
> Details
> ##############################
> Test: CheckPatch - FAIL
> Desc: Run checkpatch.pl script with rule in .checkpatch.conf
> Output:
> doc/coding-style: Update URL to kernel coding style
> WARNING:BAD_SIGN_OFF: '-signed-off-by:' is the preferred signature form
> #95: FILE: doc/coding-style.txt:9:
> -Signed-off-by: line(s)". BlueZ does not used Signed-Off lines, so including
>
> ERROR:BAD_SIGN_OFF: Unrecognized email address: 'line(s)". BlueZ does not used Signed-Off lines, so including'
> #95: FILE: doc/coding-style.txt:9:
> -Signed-off-by: line(s)". BlueZ does not used Signed-Off lines, so including

This one is quite funny, it seems checkpatch.pl does actually end up
checking for Signed-off-by: lines even on the patch contents rather
than limiting it to just the git commit not sure if there is something
we can do about it but this is the exact thing the patches wants to
prevent.

> /github/workspace/src/12869423.patch total: 1 errors, 1 warnings, 22 lines checked
>
> NOTE: For some of the reported defects, checkpatch may be able to
>       mechanically convert to the typical style using --fix or --fix-inplace.
>
> /github/workspace/src/12869423.patch has style problems, please review.
>
> NOTE: Ignored message types: COMMIT_MESSAGE COMPLEX_MACRO CONST_STRUCT FILE_PATH_CHANGES MISSING_SIGN_OFF PREFER_PACKED SPDX_LICENSE_TAG SPLIT_STRING SSCANF_TO_KSTRTO
>
> NOTE: If any of the errors are false positives, please report
>       them to the maintainer, see CHECKPATCH in MAINTAINERS.
>
>
>
>
> ---
> Regards,
> Linux Bluetooth
>


-- 
Luiz Augusto von Dentz

Re: [PATCH] doc/coding-style: Update URL to kernel coding style

[patchwork-bot+bluetooth]

Hello:

This patch was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <luiz.von.dentz@intel.com>:

On Fri,  3 Jun 2022 16:26:04 -0500 you wrote:
> From: Michael Brudevold <michael.brudevold@veranexsolutions.com>
> 
> ---
>  doc/coding-style.txt | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)

Here is the summary with links:
  - doc/coding-style: Update URL to kernel coding style
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=3c7413f49c03

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html