[PATCH] Fix "WARNING: Title underline too short."

[PATCH] Fix "WARNING: Title underline too short."

[Chang Yu]

Fix "Title underline too short" warning by extending the title line.

Signed-off-by: Chang Yu <marcus.yu.56@gmail.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index fe722c5dada9..a510ce749c3c 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6368,7 +6368,7 @@ a single guest_memfd file, but the bound ranges must not overlap).
 See KVM_SET_USER_MEMORY_REGION2 for additional details.
 
 4.143 KVM_PRE_FAULT_MEMORY
-------------------------
+---------------------------
 
 :Capability: KVM_CAP_PRE_FAULT_MEMORY
 :Architectures: none
-- 
2.45.2

Re: [PATCH] Fix "WARNING: Title underline too short."

[Shuah Khan]

On 7/22/24 22:29, Chang Yu wrote:
> Fix "Title underline too short" warning by extending the title line.

Please specify the subsystem this patch is intended for
in the summary - also check the correct format for the
summary in the submbitting patches document - you can
refer to other commits for the same file in "git log"
output.

example:

[PATCH] doc/kvm: Fix underline too short warning

Include the warning in the changelog

> 
> Signed-off-by: Chang Yu <marcus.yu.56@gmail.com>
> ---
>   Documentation/virt/kvm/api.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index fe722c5dada9..a510ce749c3c 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -6368,7 +6368,7 @@ a single guest_memfd file, but the bound ranges must not overlap).
>   See KVM_SET_USER_MEMORY_REGION2 for additional details.
>   
>   4.143 KVM_PRE_FAULT_MEMORY
> -------------------------
> +---------------------------
>   
>   :Capability: KVM_CAP_PRE_FAULT_MEMORY
>   :Architectures: none

thanks,
-- Shuah

Re: [PATCH] Fix "WARNING: Title underline too short."

[Zenghui Yu]

On 2024/7/23 23:53, Shuah Khan wrote:
> On 7/22/24 22:29, Chang Yu wrote:
> > Fix "Title underline too short" warning by extending the title line.
> 
> Please specify the subsystem this patch is intended for
> in the summary - also check the correct format for the
> summary in the submbitting patches document - you can
> refer to other commits for the same file in "git log"
> output.
> 
> example:
> 
> [PATCH] doc/kvm: Fix underline too short warning
> 
> Include the warning in the changelog

And it'd be good to always CC all the lists that get_maintainer.pl tells
you, i.e., the KVM list and LKML, even though this is a trivial change.

% ./scripts/get_maintainer.pl Documentation/virt/kvm/api.rst
Paolo Bonzini <pbonzini@redhat.com> (supporter:KERNEL VIRTUAL MACHINE (KVM))
Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
kvm@vger.kernel.org (open list:KERNEL VIRTUAL MACHINE (KVM))
linux-doc@vger.kernel.org (open list:DOCUMENTATION)
linux-kernel@vger.kernel.org (open list)

Thanks,
Zenghui