From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: David Howells <dhowells@redhat.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
keyrings@vger.kernel.org
Subject: Re: [PATCH v2 15/22] docs: security: core.rst: Fix several warnings
Date: Wed, 05 Jun 2019 10:19:28 +0000 [thread overview]
Message-ID: <20190605071928.704558cf@coco.lan> (raw)
In-Reply-To: <26617.1559728436@warthog.procyon.org.uk>
Em Wed, 05 Jun 2019 10:53:56 +0100
David Howells <dhowells@redhat.com> escreveu:
> Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
>
> > + * ``asym_eds_op`` and ``asym_verify_signature``::
> > +
> > + int (*asym_eds_op)(struct kernel_pkey_params *params,
> > + const void *in, void *out);
> > + int (*asym_verify_signature)(struct kernel_pkey_params *params,
> > + const void *in, const void *in2);
>
> That's redundant and shouldn't be necessary.
This should equally fix it:
* ::
int (*asym_eds_op)(struct kernel_pkey_params *params,
const void *in, void *out);
int (*asym_verify_signature)(struct kernel_pkey_params *params,
const void *in, const void *in2);
The thing is that we need to teach Sphinx somehow that it should not
try to interpret '*' (with is used there to identify bold/italy blocks)
Using a '::' seems better than escaping all asterisks with a backslash.
Thanks,
Mauro
prev parent reply other threads:[~2019-06-05 10:19 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1559656538.git.mchehab+samsung@kernel.org>
2019-06-04 14:17 ` [PATCH v2 14/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 15/22] docs: security: core.rst: Fix several warnings Mauro Carvalho Chehab
2019-06-05 9:53 ` David Howells
2019-06-05 10:19 ` Mauro Carvalho Chehab [this message]
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=20190605071928.704558cf@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=keyrings@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.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