diff mbox series

ocxl: do not use C++ style comments in uapi header

Message ID 20190604111632.22479-1-yamada.masahiro@socionext.com (mailing list archive)
State Accepted
Commit 2305ff225c0b1691ec2e93f3d6990e13a2e63c95
Headers show
Series ocxl: do not use C++ style comments in uapi header | expand

Checks

Context Check Description
snowpatch_ozlabs/apply_patch success Successfully applied on branch next (a3bf9fbdad600b1e4335dd90979f8d6072e4f602)
snowpatch_ozlabs/build-ppc64le success Build succeeded
snowpatch_ozlabs/build-ppc64be success Build succeeded
snowpatch_ozlabs/build-ppc64e success Build succeeded
snowpatch_ozlabs/build-pmac32 success Build succeeded
snowpatch_ozlabs/checkpatch success total: 0 errors, 0 warnings, 0 checks, 30 lines checked

Commit Message

Masahiro Yamada June 4, 2019, 11:16 a.m. UTC
Linux kernel tolerates C++ style comments these days. Actually, the
SPDX License tags for .c files start with //.

On the other hand, uapi headers are written in more strict C, where
the C++ comment style is forbidden.

Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
---

 include/uapi/misc/ocxl.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

Comments

Frederic Barrat June 4, 2019, 11:51 a.m. UTC | #1
Le 04/06/2019 à 13:16, Masahiro Yamada a écrit :
> Linux kernel tolerates C++ style comments these days. Actually, the
> SPDX License tags for .c files start with //.
> 
> On the other hand, uapi headers are written in more strict C, where
> the C++ comment style is forbidden.
> 
> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
> ---

Thanks!
Acked-by: Frederic Barrat <fbarrat@linux.ibm.com>


> 
>   include/uapi/misc/ocxl.h | 14 +++++++-------
>   1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/include/uapi/misc/ocxl.h b/include/uapi/misc/ocxl.h
> index 97937cfa3baa..6d29a60a896a 100644
> --- a/include/uapi/misc/ocxl.h
> +++ b/include/uapi/misc/ocxl.h
> @@ -33,23 +33,23 @@ struct ocxl_ioctl_attach {
>   };
>   
>   struct ocxl_ioctl_metadata {
> -	__u16 version; // struct version, always backwards compatible
> +	__u16 version; /* struct version, always backwards compatible */
>   
> -	// Version 0 fields
> +	/* Version 0 fields */
>   	__u8  afu_version_major;
>   	__u8  afu_version_minor;
> -	__u32 pasid;		// PASID assigned to the current context
> +	__u32 pasid;		/* PASID assigned to the current context */
>   
> -	__u64 pp_mmio_size;	// Per PASID MMIO size
> +	__u64 pp_mmio_size;	/* Per PASID MMIO size */
>   	__u64 global_mmio_size;
>   
> -	// End version 0 fields
> +	/* End version 0 fields */
>   
> -	__u64 reserved[13]; // Total of 16*u64
> +	__u64 reserved[13]; /* Total of 16*u64 */
>   };
>   
>   struct ocxl_ioctl_p9_wait {
> -	__u16 thread_id; // The thread ID required to wake this thread
> +	__u16 thread_id; /* The thread ID required to wake this thread */
>   	__u16 reserved1;
>   	__u32 reserved2;
>   	__u64 reserved3[3];
>
Masahiro Yamada June 4, 2019, 12:12 p.m. UTC | #2
On Tue, Jun 4, 2019 at 8:54 PM Frederic Barrat <fbarrat@linux.ibm.com> wrote:
>
>
>
> Le 04/06/2019 à 13:16, Masahiro Yamada a écrit :
> > Linux kernel tolerates C++ style comments these days. Actually, the
> > SPDX License tags for .c files start with //.
> >
> > On the other hand, uapi headers are written in more strict C, where
> > the C++ comment style is forbidden.
> >
> > Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
> > ---
>
> Thanks!
> Acked-by: Frederic Barrat <fbarrat@linux.ibm.com>
>

Please hold on this patch until
we get consensus about the C++ comment style.

Discussion just started here:
https://lore.kernel.org/patchwork/patch/1083801/
Andrew Donnellan June 5, 2019, 6:16 a.m. UTC | #3
On 4/6/19 10:12 pm, Masahiro Yamada wrote:
> On Tue, Jun 4, 2019 at 8:54 PM Frederic Barrat <fbarrat@linux.ibm.com> wrote:
>>
>>
>>
>> Le 04/06/2019 à 13:16, Masahiro Yamada a écrit :
>>> Linux kernel tolerates C++ style comments these days. Actually, the
>>> SPDX License tags for .c files start with //.
>>>
>>> On the other hand, uapi headers are written in more strict C, where
>>> the C++ comment style is forbidden.
>>>
>>> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
>>> ---
>>
>> Thanks!
>> Acked-by: Frederic Barrat <fbarrat@linux.ibm.com>
>>
> 
> Please hold on this patch until
> we get consensus about the C++ comment style.
> 
> Discussion just started here:
> https://lore.kernel.org/patchwork/patch/1083801/

If you choose to proceed with this patch:

Acked-by: Andrew Donnellan <ajd@linux.ibm.com>
Masahiro Yamada June 6, 2019, 9 a.m. UTC | #4
Hi Michael,

On Wed, Jun 5, 2019 at 3:18 PM Andrew Donnellan <ajd@linux.ibm.com> wrote:
>
> On 4/6/19 10:12 pm, Masahiro Yamada wrote:
> > On Tue, Jun 4, 2019 at 8:54 PM Frederic Barrat <fbarrat@linux.ibm.com> wrote:
> >>
> >>
> >>
> >> Le 04/06/2019 à 13:16, Masahiro Yamada a écrit :
> >>> Linux kernel tolerates C++ style comments these days. Actually, the
> >>> SPDX License tags for .c files start with //.
> >>>
> >>> On the other hand, uapi headers are written in more strict C, where
> >>> the C++ comment style is forbidden.
> >>>
> >>> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
> >>> ---
> >>
> >> Thanks!
> >> Acked-by: Frederic Barrat <fbarrat@linux.ibm.com>
> >>
> >
> > Please hold on this patch until
> > we get consensus about the C++ comment style.
> >
> > Discussion just started here:
> > https://lore.kernel.org/patchwork/patch/1083801/
>
> If you choose to proceed with this patch:
>
> Acked-by: Andrew Donnellan <ajd@linux.ibm.com>

After some discussion,
the other one was applied to the media subsystem.

Please pick up this one with Frederic and Andrew's Ack.

Thanks.
diff mbox series

Patch

diff --git a/include/uapi/misc/ocxl.h b/include/uapi/misc/ocxl.h
index 97937cfa3baa..6d29a60a896a 100644
--- a/include/uapi/misc/ocxl.h
+++ b/include/uapi/misc/ocxl.h
@@ -33,23 +33,23 @@  struct ocxl_ioctl_attach {
 };
 
 struct ocxl_ioctl_metadata {
-	__u16 version; // struct version, always backwards compatible
+	__u16 version; /* struct version, always backwards compatible */
 
-	// Version 0 fields
+	/* Version 0 fields */
 	__u8  afu_version_major;
 	__u8  afu_version_minor;
-	__u32 pasid;		// PASID assigned to the current context
+	__u32 pasid;		/* PASID assigned to the current context */
 
-	__u64 pp_mmio_size;	// Per PASID MMIO size
+	__u64 pp_mmio_size;	/* Per PASID MMIO size */
 	__u64 global_mmio_size;
 
-	// End version 0 fields
+	/* End version 0 fields */
 
-	__u64 reserved[13]; // Total of 16*u64
+	__u64 reserved[13]; /* Total of 16*u64 */
 };
 
 struct ocxl_ioctl_p9_wait {
-	__u16 thread_id; // The thread ID required to wake this thread
+	__u16 thread_id; /* The thread ID required to wake this thread */
 	__u16 reserved1;
 	__u32 reserved2;
 	__u64 reserved3[3];