Skip to contentSkip to conversation

Fix htmldocs warning seen after SEV migration patch merge

PATCH New Brijesh Singh 1 participant 5 messages Apr 22, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

cover Fix htmldocs warning seen after SEV migration patch merge

The make htmldocs reports the following warnings on kvm/next.

Documentation/virt/kvm/amd-memory-encryption.rst:308: WARNING: Inline emphasis start-string without end-string. Documentation/virt/kvm/amd-memory-encryption.rst:310: WARNING: Inline emphasis start-string without end-string. Documentation/virt/kvm/amd-memory-encryption.rst:313: WARNING: Inline emphasis start-string without end-string. Documentation/virt/kvm/amd-memory-encryption.rst:316: WARNING: Inline emphasis start-string without end-string. Documentation/virt/kvm/amd-memory-encryption.rst:319: WARNING: Inline emphasis start-string without end-string. Documentation/virt/kvm/amd-memory-encryption.rst:321: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/virt/kvm/amd-memory-encryption.rst:369: WARNING: Title underline too short.

15. KVM_SEV_RECEIVE_START
------------------------
Documentation/virt/kvm/amd-memory-encryption.rst:369: WARNING: Title underline too short.

15. KVM_SEV_RECEIVE_START
------------------------
Documentation/virt/kvm/amd-memory-encryption.rst:398: WARNING: Title underline too short.

16. KVM_SEV_RECEIVE_UPDATE_DATA
----------------------------
Documentation/virt/kvm/amd-memory-encryption.rst:398: WARNING: Title underline too short.

16. KVM_SEV_RECEIVE_UPDATE_DATA
----------------------------
Documentation/virt/kvm/amd-memory-encryption.rst:422: WARNING: Title underline too short.

17. KVM_SEV_RECEIVE_FINISH
------------------------
Documentation/virt/kvm/amd-memory-encryption.rst:422: WARNING: Title underline too short.

17. KVM_SEV_RECEIVE_FINISH
------------------------

Brijesh Singh (4):
docs: kvm: fix underline too short warning for KVM_SEV_RECEIVE_START
docs: kvm: fix underline too sort warning for
KVM_SEV_RECEIVE_UPDATE_DATA
docs: kvm: fix underline too short warning for KVM_SEV_RECEIVE_FINISH
docs: kvm: fix inline emphasis string warning for KVM_SEV_SEND_START

 Documentation/virt/kvm/amd-memory-encryption.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/4 docs: kvm: fix underline too short warning for KVM_SEV_RECEIVE_START

Fixes af43cbbf954b ("KVM: SVM: Add support for KVM_SEV_RECEIVE_START command")
---
 Documentation/virt/kvm/amd-memory-encryption.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/amd-memory-encryption.rst +1 -1
index 907adfe60090..07f8633b61cd 100644
@@ -366,7 +366,7 @@ migration can restart with a new target later.
 Returns: 0 on success, -negative on error
 
 15. KVM_SEV_RECEIVE_START
-------------------------
+--------------------------
 
 The KVM_SEV_RECEIVE_START command is used for creating the memory encryption
 context for an incoming SEV guest. To create the encryption context, the user must
Signature · 1 line
2.17.1
#2 lore raw

PATCH 2/4 docs: kvm: fix underline too sort warning for KVM_SEV_RECEIVE_UPDATE_DATA

In reply to Brijesh Singh
Fixes 15fb7de1a7f5 ("KVM: SVM: Add KVM_SEV_RECEIVE_UPDATE_DATA command)"
---
 Documentation/virt/kvm/amd-memory-encryption.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/amd-memory-encryption.rst +1 -1
index 07f8633b61cd..bc8e5b7f0c35 100644
@@ -395,7 +395,7 @@ On success, the 'handle' field contains a new handle and on error, a negative va
 For more details, see SEV spec Section 6.12.
 
 16. KVM_SEV_RECEIVE_UPDATE_DATA
-----------------------------
+-------------------------------
 
 The KVM_SEV_RECEIVE_UPDATE_DATA command can be used by the hypervisor to copy
 the incoming buffers into the guest memory region with encryption context
Signature · 1 line
2.17.1
#3 lore raw

PATCH 3/4 docs: kvm: fix underline too short warning for KVM_SEV_RECEIVE_FINISH

In reply to Brijesh Singh
Fixes 6a443def87d2 ("KVM: SVM: Add KVM_SEV_RECEIVE_FINISH command")
---
 Documentation/virt/kvm/amd-memory-encryption.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/amd-memory-encryption.rst +1 -1
index bc8e5b7f0c35..eef3eff799fe 100644
@@ -419,7 +419,7 @@ Returns: 0 on success, -negative on error
         };
 
 17. KVM_SEV_RECEIVE_FINISH
-------------------------
+--------------------------
 
 After completion of the migration flow, the KVM_SEV_RECEIVE_FINISH command can be
 issued by the hypervisor to make the guest ready for execution.
Signature · 1 line
2.17.1
#4 lore raw

PATCH 4/4 docs: kvm: fix inline emphasis string warning for KVM_SEV_SEND_START

In reply to Brijesh Singh

Fix the following warning seen with 'make htmldocs'

WARNING: Inline emphasis start-string without end-string

Fixes 4cfdd47d6d95 ("KVM: SVM: Add KVM_SEV SEND_START command")
---
 Documentation/virt/kvm/amd-memory-encryption.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/virt/kvm/amd-memory-encryption.rst +1 -0
index eef3eff799fe..b45f2358e143 100644
@@ -304,6 +304,7 @@ Parameters (in): struct kvm_sev_send_start
 Returns: 0 on success, -negative on error
 
 ::
+
         struct kvm_sev_send_start {
                 __u32 policy;                 /* guest policy */
 
Signature · 1 line
2.17.1