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

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <CAHBxVyHxRY2Ni7Do64cv2n2=WK9kkrkybZmb27UzCvRe7J09Xg@mail.gmail.com>
Date:   Mon, 28 Mar 2022 15:12:08 -0700
From:   Atish Kumar Patra <atishp@...osinc.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     "linux-kernel@...r.kernel.org List" <linux-kernel@...r.kernel.org>,
        kernel test robot <lkp@...el.com>,
        Palmer Dabbelt <palmer@...osinc.com>,
        Anup Patel <anup@...infault.org>,
        Paul Walmsley <paul.walmsley@...ive.com>,
        Palmer Dabbelt <palmer@...belt.com>,
        Albert Ou <aou@...s.berkeley.edu>,
        linux-riscv <linux-riscv@...ts.infradead.org>
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 <rdunlap@...radead.org> 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@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Atish Patra <atishp@...osinc.com>
> Cc: Palmer Dabbelt <palmer@...osinc.com>
> Cc: Anup Patel <anup@...infault.org>
> Cc: Paul Walmsley <paul.walmsley@...ive.com>
> Cc: Palmer Dabbelt <palmer@...belt.com>
> Cc: Albert Ou <aou@...s.berkeley.edu>
> Cc: linux-riscv@...ts.infradead.org
> ---
>  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@...osinc.com>