Documentation: coding-style: Clean up header guard style
diff mbox series

Message ID 20240417095112.1718987-1-kieran.bingham@ideasonboard.com
State Accepted
Commit dbd13a6f77553499607f02aabc18a7d2d3a35651
Headers show
Series
  • Documentation: coding-style: Clean up header guard style
Related show

Commit Message

Kieran Bingham April 17, 2024, 9:51 a.m. UTC
Header guards were replaced by pragma once calls with commits
0a64cf8b7645 ("libcamera: Convert to pragma once") through to
796210ecea82 ("v4l2: Convert to pragma once")

Update the coding style to reflect the updated header guard style.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 Documentation/coding-style.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Stefan Klug April 17, 2024, 11:43 a.m. UTC | #1
Hi Kieran,

that's an easy one :-)

On Wed, Apr 17, 2024 at 10:51:12AM +0100, Kieran Bingham wrote:
> Header guards were replaced by pragma once calls with commits
> 0a64cf8b7645 ("libcamera: Convert to pragma once") through to
> 796210ecea82 ("v4l2: Convert to pragma once")
> 
> Update the coding style to reflect the updated header guard style.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com> 

Cheers,
Stefan

> ---
>  Documentation/coding-style.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
> index 053fdd998351..72cb28d25189 100644
> --- a/Documentation/coding-style.rst
> +++ b/Documentation/coding-style.rst
> @@ -59,7 +59,7 @@ document:
>    underscores in between
>  * All formatting rules specified in the selected sections of the Linux kernel
>    Code Style for indentation, braces, spacing, etc
> -* Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__'
> +* Headers are guarded by the use of '#pragma once'
>  
>  Order of Includes
>  ~~~~~~~~~~~~~~~~~
> -- 
> 2.34.1
>
Laurent Pinchart April 17, 2024, 3:21 p.m. UTC | #2
On Wed, Apr 17, 2024 at 10:51:12AM +0100, Kieran Bingham wrote:
> Header guards were replaced by pragma once calls with commits
> 0a64cf8b7645 ("libcamera: Convert to pragma once") through to
> 796210ecea82 ("v4l2: Convert to pragma once")
> 
> Update the coding style to reflect the updated header guard style.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/coding-style.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
> index 053fdd998351..72cb28d25189 100644
> --- a/Documentation/coding-style.rst
> +++ b/Documentation/coding-style.rst
> @@ -59,7 +59,7 @@ document:
>    underscores in between
>  * All formatting rules specified in the selected sections of the Linux kernel
>    Code Style for indentation, braces, spacing, etc
> -* Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__'
> +* Headers are guarded by the use of '#pragma once'
>  
>  Order of Includes
>  ~~~~~~~~~~~~~~~~~

Patch
diff mbox series

diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
index 053fdd998351..72cb28d25189 100644
--- a/Documentation/coding-style.rst
+++ b/Documentation/coding-style.rst
@@ -59,7 +59,7 @@  document:
   underscores in between
 * All formatting rules specified in the selected sections of the Linux kernel
   Code Style for indentation, braces, spacing, etc
-* Header guards are formatted as '__LIBCAMERA_FILE_NAME_H__'
+* Headers are guarded by the use of '#pragma once'
 
 Order of Includes
 ~~~~~~~~~~~~~~~~~