From: Jonathan Corbet <corbet@lwn.net>
To: Joe Perches <joe@perches.com>
Cc: Gary R Hook <ghook@amd.com>, "Hook, Gary" <Gary.Hook@amd.com>,
"herbert@gondor.apana.org.au" <herbert@gondor.apana.org.au>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-crypto@vger.kernel.org" <linux-crypto@vger.kernel.org>,
"davem@davemloft.net" <davem@davemloft.net>
Subject: Re: [PATCH 0/3] Clean up crypto documentation
Date: Mon, 24 Jun 2019 14:37:48 -0600 [thread overview]
Message-ID: <20190624143748.7fcfe623@lwn.net> (raw)
In-Reply-To: <977bc7c484ef55ff78de51d7555afcc3c3350b1e.camel@perches.com>
On Mon, 24 Jun 2019 13:29:42 -0700
Joe Perches <joe@perches.com> wrote:
> > Finally, would you prefer a v2 of the patch set? Happy to do
> > whatever is preferred, of course.
>
> Whatever Jonathan decides is fine with me.
> Mine was just a plea to avoid unnecessarily
> making the source text harder to read as
> that's what I mostly use.
Usually Herbert seems to take crypto docs, so it's not necessarily up to
me :)
I don't see much that's objectionable here. But...
> I don't know if this extension is valid yet, but
> I believe just using <function_name>() is more
> readable as text than ``<function_name>`` or
> :c:func:`<function_name>`
It's been "valid" since I wrote it...it's just not upstream yet :) I
expect it to be in 5.3, though. So the best way to refer to a kernel
function, going forward, is just function() with no markup needed.
Thanks,
jon
next prev parent reply other threads:[~2019-06-24 20:37 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-24 19:07 [PATCH 0/3] Clean up crypto documentation Hook, Gary
2019-06-24 19:07 ` [PATCH 1/3] crypto: doc - Add parameter documentation Hook, Gary
2019-06-24 19:07 ` [PATCH 2/3] crypto: doc - Describe the crypto engine Hook, Gary
2019-06-24 22:03 ` Eric Biggers
2019-06-25 13:05 ` Gary R Hook
2019-06-24 19:07 ` [PATCH 3/3] crypto: doc - Fix formatting of new crypto engine content Hook, Gary
2019-06-24 19:30 ` [PATCH 0/3] Clean up crypto documentation Joe Perches
2019-06-24 20:06 ` Gary R Hook
2019-06-24 20:29 ` Joe Perches
2019-06-24 20:37 ` Jonathan Corbet [this message]
2019-06-24 22:37 ` Joe Perches
2019-06-25 13:33 ` Gary R Hook
2019-06-25 13:52 ` Jonathan Corbet
2019-06-25 15:29 ` Gary R Hook
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=20190624143748.7fcfe623@lwn.net \
--to=corbet@lwn.net \
--cc=Gary.Hook@amd.com \
--cc=davem@davemloft.net \
--cc=ghook@amd.com \
--cc=herbert@gondor.apana.org.au \
--cc=joe@perches.com \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.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;
as well as URLs for NNTP newsgroup(s).