Re: [PATCH v2 15/22] docs: security: core.rst: Fix several warnings

From: Mauro Carvalho Chehab
Date: Wed Jun 05 2019 - 06:23:37 EST


Em Wed, 05 Jun 2019 10:53:56 +0100
David Howells <dhowells@xxxxxxxxxx> escreveu:

> Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx> 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