Skip to contentSkip to conversation

linux-next: SLIMbus: doc: Fix a warning "Title underline too short"

PATCH Applied Masanari Iida 4 participants 4 messages Feb 19, 2018 – Feb 26, 2018

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 linux-next: SLIMbus: doc: Fix a warning "Title underline too short"

This patch fixes a warning during "make xmldocs"

Documentation/driver-api/slimbus.rst:93:
WARNING: Title underline too short.

---
 Documentation/driver-api/slimbus.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/driver-api/slimbus.rst +1 -1
index 7555ecd538de..a97449cf603a 100644
@@ -90,7 +90,7 @@ controller resets the bus. This notification allows the driver to take necessary
 steps to boot the device so that it's functional after the bus has been reset.
 
 Driver and Controller APIs:
---------------------------
+---------------------------
 .. kernel-doc:: include/linux/slimbus.h
    :internal:
 
Signature · 1 line
2.16.2.246.ga4ee44448fe9
#2 lore raw
In reply to Masanari Iida
Quoted 4 lines · Masanari Iida

Driver and Controller APIs:
---------------------------
+---------------------------
.. kernel-doc:: include/linux/slimbus.h

Is this the right fix? Shouldn't we rather delete the : instead? We don't normally have a colon at the end of subsection titles.

reviewer
#3 lore raw
Quoted 8 lines · Matthew Wilcox
Quoted 4 lines · Masanari Iida

Driver and Controller APIs:
---------------------------
+---------------------------
.. kernel-doc:: include/linux/slimbus.h

Is this the right fix? Shouldn't we rather delete the : instead? We don't normally have a colon at the end of subsection titles.

Agreed -- no ending colon.

Signature · 1 line
~Randy