Skip to contentSkip to conversation

Fix "WARNING: Title underline too short."

PATCH Superseded Chang Yu 3 participants 3 messages Jul 23, 2024

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Chang Yu

author
#0 lore raw

PATCH 1/1 Fix "WARNING: Title underline too short."

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

---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
index fe722c5dada9..a510ce749c3c 100644
@@ -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
Signature · 1 line
2.45.2
reviewer
#1 lore raw
Quoted 1 line · Chang Yu

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

Quoted 11 lines
---
  Documentation/virt/kvm/api.rst | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +0 -0
index fe722c5dada9..a510ce749c3c 100644

Documentation/virt/kvm/api.rst a single guest_memfd file, but the bound ranges must not overlap). · line 6374

Quoted 8 lines
Documentation/virt/kvm/api.rst +1 -1
@@ -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

#2 lore raw
Quoted 9 lines · Shuah Khan
Quoted 1 line · Chang Yu

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.

Quoted 5 lines

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 <[email protected]> (supporter:KERNEL VIRTUAL MACHINE (KVM)) Jonathan Corbet <[email protected]> (maintainer:DOCUMENTATION) [email protected] (open list:KERNEL VIRTUAL MACHINE (KVM)) [email protected] (open list:DOCUMENTATION) [email protected] (open list)

Thanks,
Zenghui