Re: [PATCH] linux-next: SLIMbus: doc: Fix a warning "Title underline too short"

2018-02-25 Thread Randy Dunlap
On 02/19/2018 06:32 AM, Matthew Wilcox wrote:
> On Mon, Feb 19, 2018 at 10:55:50PM +0900, Masanari Iida wrote:
>>  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.

-- 
~Randy


Re: [PATCH] linux-next: SLIMbus: doc: Fix a warning "Title underline too short"

2018-02-19 Thread Matthew Wilcox
On Mon, Feb 19, 2018 at 10:55:50PM +0900, Masanari Iida wrote:
>  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.


Re: [PATCH] linux-next: SLIMbus: doc: Fix a warning "Title underline too short"

2018-02-19 Thread Jonathan Corbet
On Mon, 19 Feb 2018 22:55:50 +0900
Masanari Iida  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 

Applied, thanks.

jon


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

2018-02-19 Thread Masanari Iida
This patch fixes a warning during "make xmldocs"

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

Signed-off-by: Masanari Iida 
---
 Documentation/driver-api/slimbus.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/slimbus.rst 
b/Documentation/driver-api/slimbus.rst
index 7555ecd538de..a97449cf603a 100644
--- a/Documentation/driver-api/slimbus.rst
+++ b/Documentation/driver-api/slimbus.rst
@@ -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:
 
-- 
2.16.2.246.ga4ee8fe9