Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art

[Jonathan Corbet]

On Wed, 25 Apr 2018 16:47:01 +0300
Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx> wrote:

> On Fri, 06 Apr 2018, Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx> wrote:
> > Using reStructuredText literal-block element with ascii-art.
> > That prevents the ascii art from being processed as
> > reStructuredText.
> >
> > Reported-by: Masanari Iida <standby24x7@xxxxxxxxx>
> > Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers")
> > Signed-off-by: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>  
> 
> Jon, this fixes a documentation build failure in v4.17-rc1. It's not
> just a warning, it's a complete fail. Our docs builder at 01.org is
> failing, apparently the same at kernel.org. Please pick it up soon.

Sorry, I'd seen the attached and was assuming Greg would ship it
Linusward.  I'll get it upstream soon.

jon

From: Greg KH <gregkh@xxxxxxxxxxxxxxxxxxx>
To: changbin.du@xxxxxxxxx
Cc: corbet@xxxxxxx, linux-doc@xxxxxxxxxxxxxxx,         linux-kernel@xxxxxxxxxxxxxxx
Subject: Re: [PATCH] Documentation: fix reST markup error in  driver-api/usb/typec.rst
Date: Sun, 8 Apr 2018 09:19:58 +0200
Sender: linux-kernel-owner@xxxxxxxxxxxxxxx

On Sun, Apr 08, 2018 at 10:47:12AM +0800, changbin.du@xxxxxxxxx wrote:
> From: Changbin Du <changbin.du@xxxxxxxxx>
> 
> There is an format error in driver-api/usb/typec.rst that breaks sphinx
> docs building.
> 
> reST markup error:
> /home/changbin/work/linux/Documentation/driver-api/usb/typec.rst:215: (SEVERE/4) Unexpected section title or transition.
> 
> ------------------------
> Documentation/Makefile:68: recipe for target 'htmldocs' failed
> make[1]: *** [htmldocs] Error 1
> Makefile:1527: recipe for target 'htmldocs' failed
> make: *** [htmldocs] Error 2
> 
> Signed-off-by: Changbin Du <changbin.du@xxxxxxxxx>
> ---
>  Documentation/driver-api/usb/typec.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)  

Thanks, someone else already sent this, sorry.  I'll be sending it
onward after 4.17-rc1 is out.

greg k-h