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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <447f265b-c7e2-49df-bd1a-76292e92cb0a@kernel.org>
Date: Mon, 9 Jun 2025 10:58:13 -0600
From: Shuah <shuah@...nel.org>
To: Abdelrahman Fekry <abdelrahmanfekry375@...il.com>,
 skhan@...uxfoundation.org
Cc: linux-kernel-mentees@...ts.linux.dev, linux-kernel@...r.kernel.org,
 linux-kselftest@...r.kernel.org
Subject: Re: [PATCH v2] selftests: ir_decoder: Convert header comment to
 proper multi-line block

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@...il.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@...s.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@...s.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