2022-03-28 23:04:46

by Randy Dunlap

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

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 <[email protected]>
Reported-by: kernel test robot <[email protected]>
Cc: Atish Patra <[email protected]>
Cc: Palmer Dabbelt <[email protected]>
Cc: Anup Patel <[email protected]>
Cc: Paul Walmsley <[email protected]>
Cc: Palmer Dabbelt <[email protected]>
Cc: Albert Ou <[email protected]>
Cc: [email protected]
---
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).

2022-03-28 23:06:23

by Atish Kumar Patra

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

On Mon, Mar 28, 2022 at 3:04 PM Randy Dunlap <[email protected]> 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 <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Cc: Atish Patra <[email protected]>
> Cc: Palmer Dabbelt <[email protected]>
> Cc: Anup Patel <[email protected]>
> Cc: Paul Walmsley <[email protected]>
> Cc: Palmer Dabbelt <[email protected]>
> Cc: Albert Ou <[email protected]>
> Cc: [email protected]
> ---
> 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 <[email protected]>

2022-03-31 23:29:16

by Palmer Dabbelt

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

On Mon, 28 Mar 2022 15:04:17 PDT (-0700), [email protected] 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 <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Cc: Atish Patra <[email protected]>
> Cc: Palmer Dabbelt <[email protected]>
> Cc: Anup Patel <[email protected]>
> Cc: Paul Walmsley <[email protected]>
> Cc: Palmer Dabbelt <[email protected]>
> Cc: Albert Ou <[email protected]>
> Cc: [email protected]
> ---
> 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, this is on for-next (still for this merge window for me).