Skip to contentSkip to conversation

Documentation: fix `make htmldocs ` warning

PATCH In review Vitor Massaru Iha 2 participants 3 messages Apr 30, 2020

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

PATCH 1/1 Documentation: fix `make htmldocs ` warning

Fix 'make htmldocs' warning:
Documentation/virt/kvm/amd-memory-encryption.rst:76: WARNING: Inline literal start-string without end-string.

---
 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 c3129b9ba5cb..57c01f531e61 100644
@@ -74,7 +74,7 @@ should point to a file descriptor that is opened on the ``/dev/sev``
 device, if needed (see individual commands).
 
 On output, ``error`` is zero on success, or an error code.  Error codes
-are defined in ``<linux/psp-dev.h>`.
+are defined in ``<linux/psp-dev.h>``.
 
 KVM implements the following commands to support common lifecycle events of SEV
 guests, such as launching, running, snapshotting, migrating and decommissioning.
Signature · 1 line
2.25.1
maintainer
#1 lore raw
Quoted 13 lines · On Thu, 30 Apr 2020 17:54:47 -0300 Vitor Massaru Iha <[email protected]> wrote:

Fix 'make htmldocs' warning:
Documentation/virt/kvm/amd-memory-encryption.rst:76: WARNING: Inline literal start-string without end-string.

---
 Documentation/virt/kvm/amd-memory-encryption.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/amd-memory-encryption.rst +0 -0
index c3129b9ba5cb..57c01f531e61 100644

Documentation/virt/kvm/amd-memory-encryption.rst should point to a file descriptor that is opened on the ``/dev/sev`` · line 77

Quoted 5 lines
Documentation/virt/kvm/amd-memory-encryption.rst +1 -1
@@ -74,7 +74,7 @@ should point to a file descriptor that is opened on the ``/dev/sev``
 device, if needed (see individual commands).
 
 On output, ``error`` is zero on success, or an error code.  Error codes
-are defined in ``<linux/psp-dev.h>`.
+are defined in ``<linux/psp-dev.h>``.

This one, too, is already fixed in docs-next. If you're doing documentation work, please work against that tree.

Also, "fix a warning" is almost never an appropriate subject line for any kernel patch. You're not fixing a warning, you're fixing some broken RST in the file. The subject line on the patch I merged fixing this problem reads:

docs: virt/kvm: close inline string literal

...which describes what is really going on.

Thanks,

jon

#2 lore raw
Quoted 37 lines · Jonathan Corbet
Quoted 20 lines · On Thu, 30 Apr 2020 17:54:47 -0300 Vitor Massaru Iha <[email protected]> wrote:

Fix 'make htmldocs' warning:
Documentation/virt/kvm/amd-memory-encryption.rst:76: WARNING:
Inline literal start-string without end-string.

---
 Documentation/virt/kvm/amd-memory-encryption.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/amd-memory-encryption.rst +0 -0
index c3129b9ba5cb..57c01f531e61 100644
@@ -74,7 +74,7 @@ should point to a file descriptor that is opened

on the ``/dev/sev``
device, if needed (see individual commands).

On output, ``error`` is zero on success, or an error code. Error
codes

Documentation/virt/kvm/amd-memory-encryption.rst should point to a file descriptor that is opened on the ``/dev/sev`` · line 77

Quoted 2 lines
Documentation/virt/kvm/amd-memory-encryption.rst +1 -1
-are defined in ``<linux/psp-dev.h>`.
+are defined in ``<linux/psp-dev.h>``.

This one, too, is already fixed in docs-next. If you're doing documentation work, please work against that tree.

Also, "fix a warning" is almost never an appropriate subject line for any
kernel patch. You're not fixing a warning, you're fixing some broken RST
in the file. The subject line on the patch I merged fixing this problem
reads:

Quoted 3 lines

docs: virt/kvm: close inline string literal

...which describes what is really going on.

Sorry. Thanks by the review.

Quoted 4 lines

Thanks,

jon