* [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning
@ 2020-04-30 20:54 Vitor Massaru Iha
2020-04-30 21:05 ` Jonathan Corbet
0 siblings, 1 reply; 3+ messages in thread
From: Vitor Massaru Iha @ 2020-04-30 20:54 UTC (permalink / raw)
To: linux-doc
Cc: kvm, corbet, brendanhiggins, linux-kernel, pbonzini,
linux-kernel-mentees
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@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>``.
KVM implements the following commands to support common lifecycle events of SEV
guests, such as launching, running, snapshotting, migrating and decommissioning.
--
2.25.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning
2020-04-30 20:54 [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning Vitor Massaru Iha
@ 2020-04-30 21:05 ` Jonathan Corbet
2020-04-30 21:22 ` Vitor Massaru Iha
0 siblings, 1 reply; 3+ messages in thread
From: Jonathan Corbet @ 2020-04-30 21:05 UTC (permalink / raw)
To: Vitor Massaru Iha
Cc: kvm, linux-doc, brendanhiggins, linux-kernel, pbonzini,
linux-kernel-mentees
On Thu, 30 Apr 2020 17:54:47 -0300
Vitor Massaru Iha <vitor@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@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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning
2020-04-30 21:05 ` Jonathan Corbet
@ 2020-04-30 21:22 ` Vitor Massaru Iha
0 siblings, 0 replies; 3+ messages in thread
From: Vitor Massaru Iha @ 2020-04-30 21:22 UTC (permalink / raw)
To: Jonathan Corbet
Cc: kvm, linux-doc, brendanhiggins, linux-kernel, pbonzini,
linux-kernel-mentees
On Thu, 2020-04-30 at 15:05 -0600, Jonathan Corbet wrote:
> On Thu, 30 Apr 2020 17:54:47 -0300
> Vitor Massaru Iha <vitor@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@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.
Sorry. Thanks by the review.
>
> Thanks,
>
> jon
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-04-30 21:22 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-30 20:54 [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning Vitor Massaru Iha
2020-04-30 21:05 ` Jonathan Corbet
2020-04-30 21:22 ` Vitor Massaru Iha
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).