[1/3] Removed extra asterisks from comment beginnings, and removed unnecessary comment end

Commit Message

Steven Davis July 7, 2024, 4:14 a.m. UTC

From 3574f0514207f9610a69d82d3dd0d018d6dce5dd Mon Sep 17 00:00:00 2001
From: Steven Davis <[e-mail]>
Date: Tue, 2 Jul 2024 22:57:24 -0400
Subject: [PATCH 1/3] Removed extra asterisk from comment beginning

It saves a byte. I'd imagine bytes are valuable in a project like this.
PS: Please forgive my previous patch email, I didn't know the guidelines well.
Signed-off-by: Steven Davis <[e-mail]
---
 kernel/module/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap July 7, 2024, 4:49 a.m. UTC | #1

On 7/6/24 9:14 PM, Gold Side wrote:
> From 3574f0514207f9610a69d82d3dd0d018d6dce5dd Mon Sep 17 00:00:00 2001
> From: Steven Davis <[e-mail]>
> Date: Tue, 2 Jul 2024 22:57:24 -0400
> Subject: [PATCH 1/3] Removed extra asterisk from comment beginning
> 
> It saves a byte. I'd imagine bytes are valuable in a project like this.

Don't think so.

> PS: Please forgive my previous patch email, I didn't know the guidelines well.
> Signed-off-by: Steven Davis <[e-mail]
> ---
>  kernel/module/main.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/module/main.c b/kernel/module/main.c
> index d18a94b973e102..25e456f4381c71 100644
> --- a/kernel/module/main.c
> +++ b/kernel/module/main.c
> @@ -450,7 +450,7 @@ bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
>       return false;
>  }
>  
> -/**
> +/*
>   * is_module_percpu_address() - test whether address is from module static percpu
>   * @addr: address to test
>   *

"/**" means "begin kernel-doc comment." Documentation is important.

Also, why drop one asterisk for this function and not for the other 5 functions in this source
file that use "/**" to begin a kernel-doc comment block?

Christophe JAILLET July 7, 2024, 5:29 a.m. UTC | #2

Le 07/07/2024 à 06:14, Gold Side a écrit :
>  From 3574f0514207f9610a69d82d3dd0d018d6dce5dd Mon Sep 17 00:00:00 2001
> From: Steven Davis <[e-mail]>
> Date: Tue, 2 Jul 2024 22:57:24 -0400
> Subject: [PATCH 1/3] Removed extra asterisk from comment beginning
> 
> It saves a byte. I'd imagine bytes are valuable in a project like this.
> PS: Please forgive my previous patch email, I didn't know the guidelines well.

Hi,

no-problem, newcomers are always welcomed and they have to learn. So, 
IMHO, making small mistakes is part of the learning curve.


People/mailing-list should be defined according to the MAINTAINERS file. 
A script helps you for that: ./scripts/get_maintainer.pl

It can be run either on a patch or on a file/directory.

Here:
	./scripts/get_maintainer.pl -f kernel/module/main.c
or
	./scripts/get_maintainer.pl your_patch.patch
give:
	Luis Chamberlain <[e-mail]> (maintainer:MODULE SUPPORT)
	[e-mail] (open list:MODULE SUPPORT)
	[e-mail] (open list:MODULE SUPPORT)

It is perfectly fine to add other people/mailing list that are relevant, 
as kernel-janitor.

If you are using git mail, it is possible to automate the creation of 
the To: and cc: fields. (see 
https://www.marcusfolkesson.se/blog/get_maintainers-and-git-send-email/). 
If using this --identify, you still can add some other --to, --cc., 
which is really convenient.



On your commit log, here are a few comments:
   - there should be a new-line before the Signed-off-by: line
   - you can add whatever you want after the --- ending the commit 
description. These extra comments are informational only, and won't be 
part of the git history. Here, your PS should have been here.
    - imperative wording is preferred when writing commit logs

You can also give a look at 
https://www.kernel.org/doc/html/latest/process/submitting-patches.html, 
if not already done.


Welcome and happy patching :)

CJ

> Signed-off-by: Steven Davis <[e-mail]
> ---
>   kernel/module/main.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/module/main.c b/kernel/module/main.c
> index d18a94b973e102..25e456f4381c71 100644
> --- a/kernel/module/main.c
> +++ b/kernel/module/main.c
> @@ -450,7 +450,7 @@ bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
>        return false;
>   }
>   
> -/**
> +/*
>    * is_module_percpu_address() - test whether address is from module static percpu
>    * @addr: address to test
>    *

Patch

diff --git a/kernel/module/main.c b/kernel/module/main.c
index d18a94b973e102..25e456f4381c71 100644
--- a/kernel/module/main.c
+++ b/kernel/module/main.c
@@ -450,7 +450,7 @@  bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
      return false;
 }
 
-/**
+/*
  * is_module_percpu_address() - test whether address is from module static percpu
  * @addr: address to test
  *