Re: [PATCH] riscv: cpu.c: don't use kernel-doc markers for comments

From: Atish Kumar Patra
Date: Mon Mar 28 2022 - 18:15:04 EST


On Mon, Mar 28, 2022 at 3:04 PM Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>
> Repair kernel-doc build warnings caused by using "/**" kernel-doc
> markers for comments that are not in kernel-doc format:
>
> cpu.c:89: warning: cannot understand function prototype: 'struct riscv_isa_ext_data isa_ext_arr[] = '
> cpu.c:114: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Cc: Atish Patra <atishp@xxxxxxxxxxxx>
> Cc: Palmer Dabbelt <palmer@xxxxxxxxxxxx>
> Cc: Anup Patel <anup@xxxxxxxxxxxxxx>
> Cc: Paul Walmsley <paul.walmsley@xxxxxxxxxx>
> Cc: Palmer Dabbelt <palmer@xxxxxxxxxxx>
> Cc: Albert Ou <aou@xxxxxxxxxxxxxxxxx>
> Cc: linux-riscv@xxxxxxxxxxxxxxxxxxx
> ---
> arch/riscv/kernel/cpu.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20220328.orig/arch/riscv/kernel/cpu.c
> +++ linux-next-20220328/arch/riscv/kernel/cpu.c
> @@ -69,7 +69,7 @@ int riscv_of_parent_hartid(struct device
> .uprop = #UPROP, \
> .isa_ext_id = EXTID, \
> }
> -/**
> +/*
> * Here are the ordering rules of extension naming defined by RISC-V
> * specification :
> * 1. All extensions should be separated from other multi-letter extensions
> @@ -110,7 +110,7 @@ static void print_isa_ext(struct seq_fil
> }
> }
>
> -/**
> +/*
> * These are the only valid base (single letter) ISA extensions as per the spec.
> * It also specifies the canonical order in which it appears in the spec.
> * Some of the extension may just be a place holder for now (B, K, P, J).

Thanks. I was just working on sending this patch after seeing the
kernel test report.
Reviewed-by: Atish Patra <atishp@xxxxxxxxxxxx>