Received-SPF: pass (google.com: domain of linux-kernel+bounces-62300-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Precedence: bulk
Mime-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset=UTF-8
Date: Mon, 12 Feb 2024 22:00:17 +0200
Message-Id: <CZ3D8KKRVFH4.Y7KBNMB4YXTS@kernel.org>
To: "Randy Dunlap" <rdunlap@infradead.org>, <linux-kernel@vger.kernel.org>
Cc: "Dave Hansen" <dave.hansen@linux.intel.com>,
 <linux-sgx@vger.kernel.org>, <x86@kernel.org>, "Kai Huang"
 <kai.huang@intel.com>
Subject: Re: [PATCH v2] x86/sgx: fix kernel-doc comment misuse
From: "Jarkko Sakkinen" <jarkko@kernel.org>
References: <20240211062434.16351-1-rdunlap@infradead.org>
In-Reply-To: <20240211062434.16351-1-rdunlap@infradead.org>

On Sun Feb 11, 2024 at 8:24 AM EET, Randy Dunlap wrote:
> Don't use "/**" for a non-kernel-doc comment. This prevents a warning
> from scripts/kernel-doc:
>
> main.c:740: warning: expecting prototype for A section metric is concaten=
ated in a way that @low bits 12(). Prototype was for sgx_calc_section_metri=
c() instead
>
> Cc: Jarkko Sakkinen <jarkko@kernel.org>
> Cc: Dave Hansen <dave.hansen@linux.intel.com>
> Cc: linux-sgx@vger.kernel.org
> Cc: x86@kernel.org
> Reviewed-by: Kai Huang <kai.huang@intel.com>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> v2: add Rev-by: Kai Huang
>
>  arch/x86/kernel/cpu/sgx/main.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/arch/x86/kernel/cpu/sgx/main.c b/arch/x86/kernel/cpu/sgx/main.c
> --- a/arch/x86/kernel/cpu/sgx/main.c
> +++ b/arch/x86/kernel/cpu/sgx/main.c
> @@ -731,7 +731,7 @@ out:
>  	return 0;
>  }
> =20
> -/**
> +/*
>   * A section metric is concatenated in a way that @low bits 12-31 define=
 the
>   * bits 12-31 of the metric and @high bits 0-19 define the bits 32-51 of=
 the
>   * metric.


Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org>

BR, Jarkko