[PATCH] crypto: ccp: Fix sev_issue_cmd code block

Bagas Sanjaya posted 1 patch 2 years ago
Documentation/virt/coco/sev-guest.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
[PATCH] crypto: ccp: Fix sev_issue_cmd code block
Posted by Bagas Sanjaya 2 years ago
Stephen Rothwell reports htmldocs warnings when merging tip tree:

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

sev_issue_cmd struct code block has unindented block marker, hence above
warnings. Fix the marker by appending it instead at the end of preceding
paragraph to silence these warnings.

Fixes: f5db8841ebe59d ("crypto: ccp: Add the SNP_PLATFORM_STATUS command")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20240202145932.31c62fd6@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/coco/sev-guest.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/virt/coco/sev-guest.rst b/Documentation/virt/coco/sev-guest.rst
index 14c9de997b7d34..ab3ccfd5b54838 100644
--- a/Documentation/virt/coco/sev-guest.rst
+++ b/Documentation/virt/coco/sev-guest.rst
@@ -68,9 +68,8 @@ counter (e.g. counter overflow), then -EIO will be returned.
         };
 
 The host ioctls are issued to a file descriptor of the /dev/sev device.
-The ioctl accepts the command ID/input structure documented below.
+The ioctl accepts the command ID/input structure documented below::
 
-::
         struct sev_issue_cmd {
                 /* Command ID */
                 __u32 cmd;

base-commit: 00bd91c99f9e8b4bb6b65c45598fbf426e1f1b53
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH] crypto: ccp: Fix sev_issue_cmd code block
Posted by Borislav Petkov 2 years ago
On Sun, Feb 04, 2024 at 06:06:04PM +0700, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warnings when merging tip tree:
> 
> Documentation/virt/coco/sev-guest.rst:75: WARNING: Inline emphasis start-string without end-string.
> Documentation/virt/coco/sev-guest.rst:78: WARNING: Inline emphasis start-string without end-string.
> Documentation/virt/coco/sev-guest.rst:81: WARNING: Inline emphasis start-string without end-string.
> Documentation/virt/coco/sev-guest.rst:83: WARNING: Definition list ends without a blank line; unexpected unindent.
> 
> sev_issue_cmd struct code block has unindented block marker, hence above
> warnings. Fix the marker by appending it instead at the end of preceding
> paragraph to silence these warnings.
> 
> Fixes: f5db8841ebe59d ("crypto: ccp: Add the SNP_PLATFORM_STATUS command")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20240202145932.31c62fd6@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/virt/coco/sev-guest.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)

https://git.kernel.org/tip/1bfca8d2800ab5ef0dfed335a2a29d1632c99411

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette
Re: [PATCH] crypto: ccp: Fix sev_issue_cmd code block
Posted by Bagas Sanjaya 2 years ago
On 2/4/24 18:26, Borislav Petkov wrote:
> On Sun, Feb 04, 2024 at 06:06:04PM +0700, Bagas Sanjaya wrote:
>> Stephen Rothwell reports htmldocs warnings when merging tip tree:
>>
>> Documentation/virt/coco/sev-guest.rst:75: WARNING: Inline emphasis start-string without end-string.
>> Documentation/virt/coco/sev-guest.rst:78: WARNING: Inline emphasis start-string without end-string.
>> Documentation/virt/coco/sev-guest.rst:81: WARNING: Inline emphasis start-string without end-string.
>> Documentation/virt/coco/sev-guest.rst:83: WARNING: Definition list ends without a blank line; unexpected unindent.
>>
>> sev_issue_cmd struct code block has unindented block marker, hence above
>> warnings. Fix the marker by appending it instead at the end of preceding
>> paragraph to silence these warnings.
>>
>> Fixes: f5db8841ebe59d ("crypto: ccp: Add the SNP_PLATFORM_STATUS command")
>> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
>> Closes: https://lore.kernel.org/linux-next/20240202145932.31c62fd6@canb.auug.org.au/
>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>> ---
>>  Documentation/virt/coco/sev-guest.rst | 3 +--
>>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> https://git.kernel.org/tip/1bfca8d2800ab5ef0dfed335a2a29d1632c99411
> 

Oops, I didn't see that commit when I was submitting. Thanks
anyway.

-- 
An old man doll... just what I always wanted! - Clara