public inbox for linux-kernel-mentees@lists.linux-foundation.org
 help / color / mirror / Atom feed
From: Shuah <shuah@kernel.org>
To: Abdelrahman Fekry <abdelrahmanfekry375@gmail.com>,
	skhan@linuxfoundation.org
Cc: linux-kernel-mentees@lists.linux.dev,
	linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org
Subject: Re: [PATCH v2] selftests: ir_decoder: Convert header comment to proper multi-line block
Date: Mon, 9 Jun 2025 10:58:13 -0600	[thread overview]
Message-ID: <447f265b-c7e2-49df-bd1a-76292e92cb0a@kernel.org> (raw)
In-Reply-To: <20250606223914.117449-1-abdelrahmanfekry375@gmail.com>

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

  reply	other threads:[~2025-06-09 16:58 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-13 22:32 [PATCH] selftests: ir_decoder: Convert header comment to proper multi-line block Abdelrahman Fekry
2025-05-22 21:28 ` Shuah Khan
2025-06-06 22:39   ` [PATCH v2] " Abdelrahman Fekry
2025-06-09 16:58     ` Shuah [this message]
  -- strict thread matches above, loose matches on Subject: below --
2025-05-23  2:29 Abdelrahman Fekry
2025-06-03 22:19 Abdelrahman Fekry

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=447f265b-c7e2-49df-bd1a-76292e92cb0a@kernel.org \
    --to=shuah@kernel.org \
    --cc=abdelrahmanfekry375@gmail.com \
    --cc=linux-kernel-mentees@lists.linux.dev \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox