All of lore.kernel.org
 help / color / mirror / Atom feed
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

WARNING: multiple messages have this Message-ID (diff)
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, 5 Jun 2019 07:19:28 -0300	[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

  reply	other threads:[~2019-06-05 10:19 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-04 14:17 [PATCH v2 00/22] Some documentation fixes Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 02/22] isdn: mISDN: remove a bogus reference to a non-existing doc Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 03/22] docs: zh_CN: get rid of basic_profiling.txt Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 04/22] docs: mm: numaperf.rst: get rid of a build warning Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 05/22] docs: bpf: get rid of two warnings Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 06/22] docs: mark orphan documents as such Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-05  6:16   ` Andrew Donnellan
2019-06-05  6:16     ` Andrew Donnellan
2019-06-05  6:16     ` Andrew Donnellan
2019-06-05  6:16     ` Andrew Donnellan
2019-06-04 14:17 ` [PATCH v2 07/22] docs: amd-memory-encryption.rst get rid of warnings Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 08/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-05  9:35   ` Jani Nikula
2019-06-05  9:35     ` Jani Nikula
2019-06-04 14:17 ` [PATCH v2 09/22] docs: zh_CN: avoid duplicate citation references Mauro Carvalho Chehab
2019-06-05  7:56   ` Alex Shi
2019-06-04 14:17 ` [PATCH v2 10/22] docs: vm: hmm.rst: fix some warnings Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 11/22] docs: it: license-rules.rst: get rid of warnings Mauro Carvalho Chehab
2019-06-04 21:53   ` Federico Vaga
2019-06-04 14:17 ` [PATCH v2 12/22] docs: gpio: driver.rst: fix a bad tag Mauro Carvalho Chehab
2019-06-07 22:08   ` Linus Walleij
2019-06-08  9:42     ` Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 13/22] docs: soundwire: locking: fix tags for a code-block Mauro Carvalho Chehab
2019-06-04 15:12   ` [alsa-devel] " Pierre-Louis Bossart
2019-06-04 15:19   ` Vinod Koul
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   ` Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 15/22] docs: security: core.rst: Fix several warnings Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-05  9:53   ` David Howells
2019-06-05  9:53     ` David Howells
2019-06-05 10:19     ` Mauro Carvalho Chehab [this message]
2019-06-05 10:19       ` Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 16/22] docs: net: dpio-driver.rst: fix two codeblock warnings Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 17/22] docs: net: sja1105.rst: fix table format Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 18/22] docs: move protection-keys.rst to the core-api book Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17   ` mchehab+samsung
2019-06-04 14:17 ` [PATCH v2 19/22] docs: fix broken documentation links Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 20/22] dt: bindings: fix some broken links from txt->yaml conversion Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17   ` Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 21/22] docs: isdn: remove hisax references from kernel-parameters.txt Mauro Carvalho Chehab
2019-06-04 14:17 ` [PATCH v2 22/22] docs: Kbuild/Makefile: allow check for missing docs at build time Mauro Carvalho Chehab
2019-06-07 17:55 ` [PATCH v2 00/22] Some documentation fixes Jonathan Corbet
2019-06-07 18:44   ` Mauro Carvalho Chehab
2019-06-08 19:44     ` Jonathan Corbet
2019-06-09  2:31       ` Mauro Carvalho Chehab
2019-06-09  2:33         ` Mauro Carvalho Chehab

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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.