All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jarkko Sakkinen <jarkko@kernel.org>
To: Sean Christopherson <seanjc@google.com>
Cc: Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	x86@kernel.org, linux-sgx@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH 1/5] x86/sgx: Add a missing colon in kernel-doc markup for "struct sgx_enclave_run"
Date: Wed, 19 Nov 2025 04:27:37 +0200	[thread overview]
Message-ID: <aR0rGRe6GU9GjsHT@kernel.org> (raw)
In-Reply-To: <20251112160708.1343355-2-seanjc@google.com>

On Wed, Nov 12, 2025 at 08:07:04AM -0800, Sean Christopherson wrote:
> Add a missing ':' for the description of sgx_enclave_run.reserved so that
> documentation for the member is correctly generated:
> 
>   WARNING: arch/x86/include/uapi/asm/sgx.h:184 struct member 'reserved' not
>   described in 'sgx_enclave_run'
> 
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/all/20251106145506.145fc620@canb.auug.org.au
> Signed-off-by: Sean Christopherson <seanjc@google.com>
> ---
>  arch/x86/include/uapi/asm/sgx.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h
> index 2dd35bbdc822..a438ea43bfd1 100644
> --- a/arch/x86/include/uapi/asm/sgx.h
> +++ b/arch/x86/include/uapi/asm/sgx.h
> @@ -166,7 +166,7 @@ typedef int (*sgx_enclave_user_handler_t)(long rdi, long rsi, long rdx,
>   * @exception_addr:		The address that triggered the exception
>   * @user_handler:		User provided callback run on exception
>   * @user_data:			Data passed to the user handler
> - * @reserved			Reserved for future extensions
> + * @reserved:			Reserved for future extensions
>   *
>   * If @user_handler is provided, the handler will be invoked on all return paths
>   * of the normal flow.  The user handler may transfer control, e.g. via a
> -- 
> 2.51.2.1041.gc1ab5b90ca-goog
> 

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

BR, Jarkko

  reply	other threads:[~2025-11-19  2:27 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-12 16:07 [PATCH 0/5] x86/sgx: Fix kernel-doc warnings Sean Christopherson
2025-11-12 16:07 ` [PATCH 1/5] x86/sgx: Add a missing colon in kernel-doc markup for "struct sgx_enclave_run" Sean Christopherson
2025-11-19  2:27   ` Jarkko Sakkinen [this message]
2025-11-12 16:07 ` [PATCH 2/5] x86/sgx: Add kernel-doc descriptions for params passed to vDSO user handler Sean Christopherson
2025-11-13  1:59   ` Huang, Kai
2025-11-13 15:09     ` Sean Christopherson
2025-11-13 19:57       ` Huang, Kai
2025-11-19  2:28   ` Jarkko Sakkinen
2025-11-12 16:07 ` [PATCH 3/5] x86/sgx: Document structs and enums with '@', not '%' Sean Christopherson
2025-11-12 16:07 ` [PATCH 4/5] x86/sgx: Remove superfluous asterisk from copyright comment in asm/sgx.h Sean Christopherson
2025-11-13  1:21   ` Huang, Kai
2025-11-19  2:28   ` Jarkko Sakkinen
2025-11-12 16:07 ` [PATCH 5/5] x86/sgx: Fix a typo in the kernel-doc comment for enum sgx_attribute Sean Christopherson
2025-11-19  2:28   ` Jarkko Sakkinen
2025-11-13  1:59 ` [PATCH 0/5] x86/sgx: Fix kernel-doc warnings Huang, Kai
2025-11-14 23:31 ` Dave Hansen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aR0rGRe6GU9GjsHT@kernel.org \
    --to=jarkko@kernel.org \
    --cc=bp@alien8.de \
    --cc=dave.hansen@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-sgx@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=seanjc@google.com \
    --cc=sfr@canb.auug.org.au \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.