linux-next: SLIMbus: doc: Fix a warning "Title underline too short"
Subsystems (2)
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
@@ -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
Quoted 6 lines · On Mon, 19 Feb 2018 22:55:50 +0900 Masanari Iida <[email protected]> wrote:
This patch fixes a warning during "make xmldocs"
Documentation/driver-api/slimbus.rst:93:
WARNING: Title underline too short.Signed-off-by Masanari Iida <[email protected]>
Applied, thanks.
jon
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.
Randy Dunlap
reviewerQuoted 8 lines · Matthew Wilcox
Quoted 4 lines · Masanari Iida
Driver and Controller APIs:
---------------------------
+---------------------------
.. kernel-doc::include/linux/slimbus.hIs 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