[PATCH i-g-t] CONTRIBUTING: Add coding style guidelines

Kamil Konieczny kamil.konieczny at linux.intel.com
Wed Mar 20 15:22:33 UTC 2024


Hi Louis,
On 2024-03-15 at 17:08:37 +0100, Louis Chauvet wrote:
> As explained in [1], the submitted patches should follow the same style as
> the Linux kernel and must be checked against checkpatch.pl, so add this
> recommendation in the CONTRIBUTING.md file.
> 
> [1]: https://lore.kernel.org/all/20240314170643.77vzqqoie2otyu4w@kamilkon-desk.igk.intel.com/
> 

There is code style mensioned at line 13, grep -n -A1 kernel CONTRIBUTING.md
gives (in second match):

13:- The code should follow kernel coding style:
14:  https://www.kernel.org/doc/html/latest/process/coding-style.html

So maybe place it after that line?

Regards,
Kamil

> Signed-off-by: Louis Chauvet <louis.chauvet at bootlin.com>
> 
> To: igt-dev at lists.freedesktop.org
> Cc: miquel.raynal at bootlin.com
> Cc: thomas.petazzoni at bootlin.com
> Cc: jeremie.dautheribes at bootlin.com
> Cc: arthurgrillo at riseup.net
> Cc: seanpaul at google.com
> Cc: marcheu at google.com
> Cc: nicolejadeyee at google.com
> Cc: kamil.konieczny at linux.intel.com
> ---
> To: igt-dev at lists.freedesktop.org
> Cc: miquel.raynal at bootlin.com
> Cc: thomas.petazzoni at bootlin.com
> Cc: jeremie.dautheribes at bootlin.com
> Cc: arthurgrillo at riseup.net
> Cc: seanpaul at google.com
> Cc: marcheu at google.com
> Cc: nicolejadeyee at google.com
> Cc: kamil.konieczny at linux.intel.com
> 
> Signed-off-by: Louis Chauvet <louis.chauvet at bootlin.com>
> ---
>  CONTRIBUTING.md | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
> index 2ab8a48f6ae9..ec8debb4091e 100644
> --- a/CONTRIBUTING.md
> +++ b/CONTRIBUTING.md
> @@ -78,6 +78,8 @@ Sending Patches
>  - Changes to the testcases are automatically tested. Take the results into
>    account before merging.
>  
> +- The coding rules are the same as for the Linux kernel. To check for common
> +  style problems, you need to use the kernel's checkpatch.pl script.
>  
>  Commit Rights
>  -------------
> 
> ---
> base-commit: ed47dd9fb6b5be6c88513c2816f0f7cfdd0e02f6
> change-id: 20240315-add_coding_style-b755454de958
> 
> Best regards,
> -- 
> Louis Chauvet <louis.chauvet at bootlin.com>
> 


More information about the igt-dev mailing list