korg/bluez
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/bluetooth/bluez.git synced 2024-11-26 21:54:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Michael Brudevold 2022-06-03 16:26:04 -05:00 committed by Luiz Augusto von Dentz
parent 5ebc2b5a3e
commit 3c7413f49c
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/coding-style.txt
View File

@ -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