All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	David Howells <dhowells@redhat.com>,
	keyrings@vger.kernel.org
Subject: [PATCH 19/22] docs: security: core.rst: Fix several warnings
Date: Wed, 29 May 2019 23:23:50 +0000	[thread overview]
Message-ID: <6543f70a5b8d53ef59614a42ef09b0b3d85ba4f7.1559171394.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1559171394.git.mchehab+samsung@kernel.org>

Multi-line literal markups only work when they're idented at the
same level, with is not the case here:

   Documentation/security/keys/core.rst:1597: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1597: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1597: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1598: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1598: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.

Fix it by using a code-block instead.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/security/keys/core.rst | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst
index 9521c4207f01..3fd60dcb2dc6 100644
--- a/Documentation/security/keys/core.rst
+++ b/Documentation/security/keys/core.rst
@@ -1594,10 +1594,12 @@ The structure has a number of fields, some of which are mandatory:
      attempted key link operation. If there is no match, -EINVAL is returned.
 
 
-  *  ``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);``
+  *  ``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);
 
      These methods are optional.  If provided the first allows a key to be
      used to encrypt, decrypt or sign a blob of data, and the second allows a
@@ -1662,8 +1664,10 @@ The structure has a number of fields, some of which are mandatory:
      required crypto isn't available.
 
 
-  *  ``int (*asym_query)(const struct kernel_pkey_params *params,
-			 struct kernel_pkey_query *info);``
+  *  ``asym_query``::
+
+       int (*asym_query)(const struct kernel_pkey_params *params,
+			 struct kernel_pkey_query *info);
 
      This method is optional.  If provided it allows information about the
      public or asymmetric key held in the key to be determined.
-- 
2.21.0

WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	David Howells <dhowells@redhat.com>,
	keyrings@vger.kernel.org
Subject: [PATCH 19/22] docs: security: core.rst: Fix several warnings
Date: Wed, 29 May 2019 20:23:50 -0300	[thread overview]
Message-ID: <6543f70a5b8d53ef59614a42ef09b0b3d85ba4f7.1559171394.git.mchehab+samsung@kernel.org> (raw)
In-Reply-To: <cover.1559171394.git.mchehab+samsung@kernel.org>

Multi-line literal markups only work when they're idented at the
same level, with is not the case here:

   Documentation/security/keys/core.rst:1597: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1597: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1597: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1598: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1598: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1600: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline literal start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.
   Documentation/security/keys/core.rst:1666: WARNING: Inline emphasis start-string without end-string.

Fix it by using a code-block instead.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/security/keys/core.rst | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst
index 9521c4207f01..3fd60dcb2dc6 100644
--- a/Documentation/security/keys/core.rst
+++ b/Documentation/security/keys/core.rst
@@ -1594,10 +1594,12 @@ The structure has a number of fields, some of which are mandatory:
      attempted key link operation. If there is no match, -EINVAL is returned.
 
 
-  *  ``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);``
+  *  ``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);
 
      These methods are optional.  If provided the first allows a key to be
      used to encrypt, decrypt or sign a blob of data, and the second allows a
@@ -1662,8 +1664,10 @@ The structure has a number of fields, some of which are mandatory:
      required crypto isn't available.
 
 
-  *  ``int (*asym_query)(const struct kernel_pkey_params *params,
-			 struct kernel_pkey_query *info);``
+  *  ``asym_query``::
+
+       int (*asym_query)(const struct kernel_pkey_params *params,
+			 struct kernel_pkey_query *info);
 
      This method is optional.  If provided it allows information about the
      public or asymmetric key held in the key to be determined.
-- 
2.21.0


  parent reply	other threads:[~2019-05-29 23:23 UTC|newest]

Thread overview: 113+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
2019-05-29 23:23 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [Xen-devel] " Mauro Carvalho Chehab
2019-05-29 23:23 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` mchehab+samsung
2019-05-29 23:23 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 01/22] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
2019-05-30 16:57   ` Rafael J. Wysocki
2019-05-29 23:23 ` [PATCH 02/22] isdn: mISDN: remove a bogus reference to a non-existing doc Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 03/22] dt: fix broken references to nand.txt Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 04/22] docs: zh_CN: get rid of basic_profiling.txt Mauro Carvalho Chehab
2019-06-02 14:36   ` Alex Shi
2019-05-29 23:23 ` [PATCH 05/22] mfd: madera: Fix bad reference to pinctrl.txt file Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 06/22] doc: it_IT: fix reference to magic-number.rst Mauro Carvalho Chehab
2019-05-30 20:15   ` Federico Vaga
2019-05-29 23:23 ` [PATCH 07/22] docs: mm: numaperf.rst: get rid of a build warning Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 08/22] docs: bpf: get rid of two warnings Mauro Carvalho Chehab
2019-05-30 18:08   ` Song Liu
2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-30  8:30   ` Paolo Bonzini
2019-05-30  8:30     ` Paolo Bonzini
2019-05-30  8:30     ` Paolo Bonzini
2019-05-30  8:30     ` Paolo Bonzini
2019-06-03  7:32   ` Christophe Leroy
2019-06-03  7:32     ` Christophe Leroy
2019-06-03  7:32     ` Christophe Leroy
2019-06-03  7:32     ` Christophe Leroy
2019-06-04 10:10     ` Mauro Carvalho Chehab
2019-06-04 10:10       ` Mauro Carvalho Chehab
2019-06-04 10:10       ` Mauro Carvalho Chehab
2019-06-04 10:10       ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 10/22] docs: amd-memory-encryption.rst get rid of warnings Mauro Carvalho Chehab
2019-05-30  8:30   ` Paolo Bonzini
2019-05-29 23:23 ` [PATCH 11/22] gpu: amdgpu: fix broken amdgpu_dma_buf.c references Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-31 14:00   ` Christian König
2019-05-31 15:03     ` Alex Deucher
2019-05-31 15:03       ` Alex Deucher
2019-05-29 23:23 ` [PATCH 12/22] gpu: i915.rst: Fix references to renamed files Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-31  7:40   ` Jani Nikula
2019-05-31  7:40     ` Jani Nikula
2019-05-31  9:02   ` Joonas Lahtinen
2019-05-31  9:02     ` Joonas Lahtinen
2019-05-29 23:23 ` [PATCH 13/22] docs: zh_CN: avoid duplicate citation references Mauro Carvalho Chehab
2019-06-02 15:01   ` Alex Shi
2019-06-04 10:20     ` Mauro Carvalho Chehab
2019-06-04 10:43       ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 14/22] docs: vm: hmm.rst: fix some warnings Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 15/22] docs: it: license-rules.rst: get rid of warnings Mauro Carvalho Chehab
2019-05-30 20:23   ` Federico Vaga
2019-05-29 23:23 ` [PATCH 16/22] docs: gpio: driver.rst: fix a bad tag Mauro Carvalho Chehab
2019-06-07 20:57   ` Linus Walleij
2019-05-29 23:23 ` [PATCH 17/22] docs: soundwire: locking: fix tags for a code-block Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 18/22] docs: security: trusted-encrypted.rst: fix code-block tag Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-30 19:43   ` James Morris
2019-05-30 19:43     ` James Morris
2019-06-03 20:29   ` Jarkko Sakkinen
2019-06-03 20:29     ` Jarkko Sakkinen
2019-05-29 23:23 ` Mauro Carvalho Chehab [this message]
2019-05-29 23:23   ` [PATCH 19/22] docs: security: core.rst: Fix several warnings Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 20/22] docs: net: dpio-driver.rst: fix two codeblock warnings Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 21/22] docs: net: sja1105.rst: fix table format Mauro Carvalho Chehab
2019-05-29 23:26   ` Vladimir Oltean
2019-05-29 23:23 ` [PATCH 22/22] docs: fix broken documentation links Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-29 23:23   ` [Xen-devel] " Mauro Carvalho Chehab
2019-05-29 23:23   ` Mauro Carvalho Chehab
2019-05-30  7:21   ` Wolfram Sang
2019-05-30  7:21     ` Wolfram Sang
2019-05-30  7:21     ` Wolfram Sang
2019-05-30 13:12   ` Sven Van Asbroeck
2019-05-30 20:17   ` Federico Vaga
2019-05-30 20:17   ` Federico Vaga
2019-05-30 20:17     ` Federico Vaga
2019-05-30 22:49     ` Michael S. Tsirkin
2019-05-30 22:49     ` Michael S. Tsirkin
2019-05-30 22:49     ` Michael S. Tsirkin
2019-05-30 22:49       ` Michael S. Tsirkin
2019-05-30 22:49       ` [Xen-devel] " Michael S. Tsirkin
2019-05-30 22:49       ` Michael S. Tsirkin
2019-05-30 22:49       ` Michael S. Tsirkin
2019-05-30 22:49       ` Michael S. Tsirkin
2019-05-30 22:49       ` mst
2019-06-03  7:34   ` Christophe Leroy
2019-06-03  7:34   ` Christophe Leroy
2019-06-03  7:34     ` Christophe Leroy
2019-06-03  7:34     ` Christophe Leroy
2019-06-04  9:46     ` Mauro Carvalho Chehab
2019-06-04  9:46       ` Mauro Carvalho Chehab
2019-06-04  9:46       ` Mauro Carvalho Chehab
2019-06-04  9:58       ` Mauro Carvalho Chehab
2019-06-04  9:58         ` Mauro Carvalho Chehab
2019-06-04  9:58         ` Mauro Carvalho Chehab
2019-06-04  9:58       ` Mauro Carvalho Chehab
2019-06-03 15:41   ` Mark Brown
2019-06-03 15:41     ` Mark Brown
2019-06-03 15:41     ` Mark Brown
2019-06-04  6:12   ` Bhupesh Sharma
2019-06-04  6:12   ` Bhupesh Sharma
2019-06-04  6:12     ` Bhupesh Sharma
2019-06-04  6:12     ` Bhupesh Sharma
2019-05-29 23:23 ` 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=6543f70a5b8d53ef59614a42ef09b0b3d85ba4f7.1559171394.git.mchehab+samsung@kernel.org \
    --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.