[Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning

[Jonathan Corbet]

On Thu, 30 Apr 2020 17:54:47 -0300
Vitor Massaru Iha <vitor at massaru.org> wrote:

> Fix 'make htmldocs' warning:
> Documentation/virt/kvm/amd-memory-encryption.rst:76: WARNING: Inline literal start-string without end-string.
> 
> Signed-off-by: Vitor Massaru Iha <vitor at massaru.org>
> ---
>  Documentation/virt/kvm/amd-memory-encryption.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/amd-memory-encryption.rst b/Documentation/virt/kvm/amd-memory-encryption.rst
> index c3129b9ba5cb..57c01f531e61 100644
> --- a/Documentation/virt/kvm/amd-memory-encryption.rst
> +++ b/Documentation/virt/kvm/amd-memory-encryption.rst
> @@ -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