public inbox for linux-sgx@vger.kernel.org
 help / color / mirror / Atom feed
From: Thorsten Blum <thorsten.blum@linux.dev>
To: "Huang, Kai" <kai.huang@intel.com>
Cc: "jarkko@kernel.org" <jarkko@kernel.org>,
	"x86@kernel.org" <x86@kernel.org>, "bp@alien8.de" <bp@alien8.de>,
	"hpa@zytor.com" <hpa@zytor.com>,
	"mingo@redhat.com" <mingo@redhat.com>,
	"tglx@linutronix.de" <tglx@linutronix.de>,
	"dave.hansen@linux.intel.com" <dave.hansen@linux.intel.com>,
	"linux-sgx@vger.kernel.org" <linux-sgx@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] x86/sgx: Fix typos and formatting in function comments
Date: Tue, 4 Nov 2025 20:13:43 +0100	[thread overview]
Message-ID: <71675CA4-D76B-4B81-B71B-8C2B79AAAC3C@linux.dev> (raw)
In-Reply-To: <717cb54f7ac6dd1f94a5c57c10a8cb377eb199bd.camel@intel.com>

On 4. Nov 2025, at 00:47, Huang, Kai wrote:
> It seems we don't have a consistent way of describing return values in the
> k-doc comments in sgx/main.c.  E.g.,
> 
> /**
> * sgx_unmark_page_reclaimable() - Remove a page from the reclaim list
> 
> ...
> 
> * Return:
> *   0 on success,
> *   -EBUSY if the page is in the process of being reclaimed
> */
> 
> 
> /**
> * sgx_alloc_epc_page() - Allocate an EPC page
> 
> ...
> 
> * Return:
> *   an EPC page,
> *   -errno on error
> */
> 
> Perhaps we should make them consistent in format.
> 
> But I think this can be done separately from fixing the typos.  Maybe you 
> can split out the typo fixing as a separate patch, and have another patch to
> fixing the return value description?

I used the style mostly found in main.c and ioctl.c - would that be the
"correct" format for the others as well? Happy to submit a separate
patch if it's worth it.

Thanks,
Thorsten


  reply	other threads:[~2025-11-04 19:14 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-03  9:01 [PATCH] x86/sgx: Fix typos and formatting in function comments Thorsten Blum
2025-11-03 23:47 ` Huang, Kai
2025-11-04 19:13   ` Thorsten Blum [this message]
2025-11-04 21:01     ` Huang, Kai

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=71675CA4-D76B-4B81-B71B-8C2B79AAAC3C@linux.dev \
    --to=thorsten.blum@linux.dev \
    --cc=bp@alien8.de \
    --cc=dave.hansen@linux.intel.com \
    --cc=hpa@zytor.com \
    --cc=jarkko@kernel.org \
    --cc=kai.huang@intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-sgx@vger.kernel.org \
    --cc=mingo@redhat.com \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox