From: Jonathan Corbet <corbet@lwn.net>
To: Vitor Massaru Iha <vitor@massaru.org>
Cc: kvm@vger.kernel.org, linux-doc@vger.kernel.org,
brendanhiggins@google.com, linux-kernel@vger.kernel.org,
pbonzini@redhat.com,
linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning
Date: Thu, 30 Apr 2020 15:05:01 -0600 [thread overview]
Message-ID: <20200430150501.033bfa20@lwn.net> (raw)
In-Reply-To: <20200430205447.93458-1-vitor@massaru.org>
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
next prev parent reply other threads:[~2020-04-30 21:05 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-30 20:54 [Linux-kernel-mentees] [PATCH] Documentation: fix `make htmldocs ` warning Vitor Massaru Iha
2020-04-30 21:05 ` Jonathan Corbet [this message]
2020-04-30 21:22 ` Vitor Massaru Iha
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200430150501.033bfa20@lwn.net \
--to=corbet@lwn.net \
--cc=brendanhiggins@google.com \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pbonzini@redhat.com \
--cc=vitor@massaru.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).