From: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
To: Sean Christopherson <sean.j.christopherson@intel.com>
Cc: linux-sgx@vger.kernel.org
Subject: Re: [PATCH for v24 3/3] x86/sgx: Remove a subordinate clause
Date: Tue, 5 Nov 2019 00:36:59 +0200 [thread overview]
Message-ID: <20191104223636.GC3606@linux.intel.com> (raw)
In-Reply-To: <20191104212122.GC5960@linux.intel.com>
On Mon, Nov 04, 2019 at 01:21:22PM -0800, Sean Christopherson wrote:
> On Mon, Nov 04, 2019 at 10:01:41PM +0200, Jarkko Sakkinen wrote:
> > The subordinate clause of last sentence of the sgx_ioc_enclave_pages()
> > does not provide any insight not already provided. Thus, remove it.
>
> Isn't the whole point of the documentation to help the user understand
> *how* to use the API, not simply state exactly what the code does?
For kdoc it should explain in clear and concise way
That clause does not provide any help for that. It just repeats with
different vocabulary the exact same thing as was already said.
> > Also, using "i.e." (and "e.g.") in the documentation should be
> > considered a bad practice because it leaves it open ended.
>
> How does stating the practical effect of the semantics leave the docs open
> ended? The man pages for open[1], close[2], read[3], dlopen[4], etc...
> all provide examples (usually with "for example" verbiage) to call out
> common scenarios to help the reader understand the details, and close()
> also uses "i.e." to clarify.
I did not find the use of "i.e." or "e.g." from those. When they
introduce an example it is done in a more structured way, not as
a subordinate clause.
/Jarkko
next prev parent reply other threads:[~2019-11-04 22:37 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-04 20:01 [PATCH for v24 1/3] x86/sgx: Use GFP_KERNEL for allocations Jarkko Sakkinen
2019-11-04 20:01 ` [PATCH for v24 2/3] x86/sgx: Destroy enclave if EADD fails Jarkko Sakkinen
2019-11-04 20:54 ` Sean Christopherson
2019-11-04 22:31 ` Jarkko Sakkinen
2019-11-04 20:01 ` [PATCH for v24 3/3] x86/sgx: Remove a subordinate clause Jarkko Sakkinen
2019-11-04 21:21 ` Sean Christopherson
2019-11-04 22:36 ` Jarkko Sakkinen [this message]
2019-11-04 22:37 ` Jarkko Sakkinen
2019-11-04 20:46 ` [PATCH for v24 1/3] x86/sgx: Use GFP_KERNEL for allocations Sean Christopherson
2019-11-04 22:26 ` Jarkko Sakkinen
2019-11-05 2:17 ` Sean Christopherson
2019-11-06 21:54 ` Jarkko Sakkinen
2019-11-06 21:59 ` Jarkko Sakkinen
2019-11-06 22:02 ` Jarkko Sakkinen
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=20191104223636.GC3606@linux.intel.com \
--to=jarkko.sakkinen@linux.intel.com \
--cc=linux-sgx@vger.kernel.org \
--cc=sean.j.christopherson@intel.com \
/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;
as well as URLs for NNTP newsgroup(s).