[PATCH] selftests: ir_decoder: Convert header comment to proper multi-line block

[PATCH] selftests: ir_decoder: Convert header comment to proper multi-line block

[Abdelrahman Fekry]

The test file for the IR decoder used single-line  comments at the top
to document its purpose and licensing, which is inconsistent with the style
used throughout the Linux kernel.

in this patch i converted the file header to a proper multi-line comment block
(/*) that aligns with standard kernel practices. This improves
readability, consistency across selftests, and ensures the license and
documentation are clearly visible in a familiar format.

No functional changes have been made.

Signed-off-by: Abdelrahman Fekry <Abdelrahmanfekry375@gmail.com>
---
 tools/testing/selftests/ir/ir_loopback.c | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/tools/testing/selftests/ir/ir_loopback.c b/tools/testing/selftests/ir/ir_loopback.c
index f4a15cbdd5ea..2de4a6296f35 100644
--- a/tools/testing/selftests/ir/ir_loopback.c
+++ b/tools/testing/selftests/ir/ir_loopback.c
@@ -1,14 +1,15 @@
 // SPDX-License-Identifier: GPL-2.0
-// test ir decoder
-//
-// Copyright (C) 2018 Sean Young <sean@mess.org>
-
-// When sending LIRC_MODE_SCANCODE, the IR will be encoded. rc-loopback
-// will send this IR to the receiver side, where we try to read the decoded
-// IR. Decoding happens in a separate kernel thread, so we will need to
-// wait until that is scheduled, hence we use poll to check for read
-// readiness.
-
+/* Copyright (C) 2018 Sean Young <sean@mess.org>
+ * 
+ * Selftest for IR decoder 
+ *
+ *
+ * When sending LIRC_MODE_SCANCODE, the IR will be encoded. rc-loopback
+ * will send this IR to the receiver side, where we try to read the decoded
+ * IR. Decoding happens in a separate kernel thread, so we will need to
+ * wait until that is scheduled, hence we use poll to check for read
+ * readiness.
+*/
 #include <linux/lirc.h>
 #include <errno.h>
 #include <stdio.h>
-- 
2.25.1

Re: [PATCH] selftests: ir_decoder: Convert header comment to proper multi-line block

[Shuah Khan]

On 5/13/25 16:32, Abdelrahman Fekry wrote:
> The test file for the IR decoder used single-line  comments at the top
> to document its purpose and licensing, which is inconsistent with the style
> used throughout the Linux kernel.
> 
> in this patch i converted the file header to a proper multi-line comment block
> (/*) that aligns with standard kernel practices. This improves
> readability, consistency across selftests, and ensures the license and
> documentation are clearly visible in a familiar format.
> 
> No functional changes have been made.
> 
> Signed-off-by: Abdelrahman Fekry <Abdelrahmanfekry375@gmail.com>

Did you run checkpatch on this patch? I am seeing

CHECK: From:/Signed-off-by: email comments mismatch: 'From: Abdelrahman Fekry <abdelrahmanfekry375@gmail.com>' != 'Signed-off-by: Abdelrahman Fekry <Abdelrahmanfekry375@gmail.com>'

Fix these as well.

ERROR: trailing whitespace
#136: FILE: tools/testing/selftests/ir/ir_loopback.c:3:
+ * $

ERROR: trailing whitespace
#137: FILE: tools/testing/selftests/ir/ir_loopback.c:4:
+ * Selftest for IR decoder $

Please fix it and send v2.

thanks,
-- Shuah

[PATCH v2] selftests: ir_decoder: Convert header comment to proper multi-line block

[Abdelrahman Fekry]

So, this is an updated version following
the right way of writing change logs while
making sure the signed-off-by mismatch is fixed.

The test file for the IR decoder used single-line comments
at the top to document its purpose and licensing,
which is inconsistent with the style used throughout the
Linux kernel.

In this patch i converted the file header to
a proper multi-line comment block
(/*) that aligns with standard kernel practices.
This improves readability, consistency across selftests,
and ensures the license and documentation are
clearly visible in a familiar format.

No functional changes have been made.

Signed-off-by: Abdelrahman Fekry <abdelrahmanfekry375@gmail.com>
---
Changes in v2:
- Fixed multiple trailing whitespace errors
- Fixed Signed-off-by mismatch
- Appropriate change log
 tools/testing/selftests/ir/ir_loopback.c | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/tools/testing/selftests/ir/ir_loopback.c b/tools/testing/selftests/ir/ir_loopback.c
index f4a15cbdd5ea..c94faa975630 100644
--- a/tools/testing/selftests/ir/ir_loopback.c
+++ b/tools/testing/selftests/ir/ir_loopback.c
@@ -1,14 +1,17 @@
 // SPDX-License-Identifier: GPL-2.0
-// test ir decoder
-//
-// Copyright (C) 2018 Sean Young <sean@mess.org>
-
-// When sending LIRC_MODE_SCANCODE, the IR will be encoded. rc-loopback
-// will send this IR to the receiver side, where we try to read the decoded
-// IR. Decoding happens in a separate kernel thread, so we will need to
-// wait until that is scheduled, hence we use poll to check for read
-// readiness.
-
+/* Copyright (C) 2018 Sean Young <sean@mess.org>
+ *
+ * Selftest for IR decoder
+ *
+ *
+ * When sending LIRC_MODE_SCANCODE, the IR will be encoded.
+ * rc-loopback will send this IR to the receiver side,
+ * where we try to read the decoded IR.
+ * Decoding happens in a separate kernel thread,
+ * so we will need to wait until that is scheduled,
+ * hence we use poll to check for read
+ * readiness.
+ */
 #include <linux/lirc.h>
 #include <errno.h>
 #include <stdio.h>
-- 
2.25.1

Re: [PATCH v2] selftests: ir_decoder: Convert header comment to proper multi-line block

[Shuah]

On 6/6/25 16:39, Abdelrahman Fekry wrote:
> So, this is an updated version following
> the right way of writing change logs while
> making sure the signed-off-by mismatch is fixed.

The above doesn't belong in the change log

> 
> The test file for the IR decoder used single-line comments
> at the top to document its purpose and licensing,
> which is inconsistent with the style used throughout the
> Linux kernel.
> 
> In this patch i converted the file header to
> a proper multi-line comment block
> (/*) that aligns with standard kernel practices.
> This improves readability, consistency across selftests,
> and ensures the license and documentation are
> clearly visible in a familiar format.

Refer to the submitting patches document for details on imperative
mood.

> 
> No functional changes have been made.
> 
> Signed-off-by: Abdelrahman Fekry <abdelrahmanfekry375@gmail.com>
> ---
> Changes in v2:
> - Fixed multiple trailing whitespace errors
> - Fixed Signed-off-by mismatch
> - Appropriate change log
>   tools/testing/selftests/ir/ir_loopback.c | 23 +++++++++++++----------
>   1 file changed, 13 insertions(+), 10 deletions(-)
> 
> diff --git a/tools/testing/selftests/ir/ir_loopback.c b/tools/testing/selftests/ir/ir_loopback.c
> index f4a15cbdd5ea..c94faa975630 100644
> --- a/tools/testing/selftests/ir/ir_loopback.c
> +++ b/tools/testing/selftests/ir/ir_loopback.c
> @@ -1,14 +1,17 @@
>   // SPDX-License-Identifier: GPL-2.0
> -// test ir decoder
> -//
> -// Copyright (C) 2018 Sean Young <sean@mess.org>
> -
> -// When sending LIRC_MODE_SCANCODE, the IR will be encoded. rc-loopback
> -// will send this IR to the receiver side, where we try to read the decoded
> -// IR. Decoding happens in a separate kernel thread, so we will need to
> -// wait until that is scheduled, hence we use poll to check for read
> -// readiness.
> -
> +/* Copyright (C) 2018 Sean Young <sean@mess.org>
> + *
> + * Selftest for IR decoder
> + *
> + *
> + * When sending LIRC_MODE_SCANCODE, the IR will be encoded.
> + * rc-loopback will send this IR to the receiver side,
> + * where we try to read the decoded IR.
> + * Decoding happens in a separate kernel thread,
> + * so we will need to wait until that is scheduled,
> + * hence we use poll to check for read
> + * readiness.
> + */
>   #include <linux/lirc.h>
>   #include <errno.h>
>   #include <stdio.h>


I don't think this patch is necessary. We have files that use // style
comments. How did you find this issue.

thanks,
-- Shuah