2024-02-02 16:33:17

by Michael Roth

[permalink] [raw]
Subject: [PATCH] Documentation: virt: Fix up pre-formatted text block for SEV ioctls

A missing newline after "::" resulted in the htmldocs build failing to
recognize the start of a pre-formatted block of text, resulting in
warnings being generated during the build. Fix this by adding in the
missing newline.

Reported-by: Stephen Rothwell <[email protected]>
Closes: https://lore.kernel.org/linux-next/[email protected]/
Fixes: f5db8841ebe5 ("crypto: ccp: Add the SNP_PLATFORM_STATUS command")
Signed-off-by: Michael Roth <[email protected]>
---
Documentation/virt/coco/sev-guest.rst | 1 +
1 file changed, 1 insertion(+)

diff --git a/Documentation/virt/coco/sev-guest.rst b/Documentation/virt/coco/sev-guest.rst
index 14c9de997b7d..e1eaf6a830ce 100644
--- a/Documentation/virt/coco/sev-guest.rst
+++ b/Documentation/virt/coco/sev-guest.rst
@@ -71,6 +71,7 @@ The host ioctls are issued to a file descriptor of the /dev/sev device.
The ioctl accepts the command ID/input structure documented below.

::
+
struct sev_issue_cmd {
/* Command ID */
__u32 cmd;
--
2.25.1



Subject: [tip: x86/sev] Documentation: virt: Fix up pre-formatted text block for SEV ioctls

The following commit has been merged into the x86/sev branch of tip:

Commit-ID: 1bfca8d2800ab5ef0dfed335a2a29d1632c99411
Gitweb: https://git.kernel.org/tip/1bfca8d2800ab5ef0dfed335a2a29d1632c99411
Author: Michael Roth <[email protected]>
AuthorDate: Fri, 02 Feb 2024 10:05:44 -06:00
Committer: Borislav Petkov (AMD) <[email protected]>
CommitterDate: Fri, 02 Feb 2024 17:21:22 +01:00

Documentation: virt: Fix up pre-formatted text block for SEV ioctls

A missing newline after "::" resulted in the htmldocs build failing to
recognize the start of a pre-formatted block of text, resulting in

kernel/linux/Documentation/virt/coco/sev-guest.rst:75: WARNING: Inline emphasis start-string without end-string.
kernel/linux/Documentation/virt/coco/sev-guest.rst:78: WARNING: Inline emphasis start-string without end-string.
kernel/linux/Documentation/virt/coco/sev-guest.rst:81: WARNING: Inline emphasis start-string without end-string.
kernel/linux/Documentation/virt/coco/sev-guest.rst:83: WARNING: Definition list ends without a blank line; unexpected unindent.

Fix it.

Fixes: f5db8841ebe5 ("crypto: ccp: Add the SNP_PLATFORM_STATUS command")
Closes: https://lore.kernel.org/linux-next/[email protected]/
Reported-by: Stephen Rothwell <[email protected]>
Signed-off-by: Michael Roth <[email protected]>
Signed-off-by: Borislav Petkov (AMD) <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
---
Documentation/virt/coco/sev-guest.rst | 1 +
1 file changed, 1 insertion(+)

diff --git a/Documentation/virt/coco/sev-guest.rst b/Documentation/virt/coco/sev-guest.rst
index 14c9de9..e1eaf6a 100644
--- a/Documentation/virt/coco/sev-guest.rst
+++ b/Documentation/virt/coco/sev-guest.rst
@@ -71,6 +71,7 @@ The host ioctls are issued to a file descriptor of the /dev/sev device.
The ioctl accepts the command ID/input structure documented below.

::
+
struct sev_issue_cmd {
/* Command ID */
__u32 cmd;