2018-04-08 03:00:10

by Du, Changbin

[permalink] [raw]
Subject: [PATCH] Documentation: fix reST markup error in driver-api/usb/typec.rst

From: Changbin Du <[email protected]>

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 <[email protected]>
---
Documentation/driver-api/usb/typec.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/usb/typec.rst b/Documentation/driver-api/usb/typec.rst
index feb3194..48ff580 100644
--- a/Documentation/driver-api/usb/typec.rst
+++ b/Documentation/driver-api/usb/typec.rst
@@ -210,7 +210,7 @@ If the connector is dual-role capable, there may also be a switch for the data
role. USB Type-C Connector Class does not supply separate API for them. The
port drivers can use USB Role Class API with those.

-Illustration of the muxes behind a connector that supports an alternate mode:
+Illustration of the muxes behind a connector that supports an alternate mode::

------------------------
| Connector |
--
2.7.4



2018-04-08 07:23:54

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] Documentation: fix reST markup error in driver-api/usb/typec.rst

On Sun, Apr 08, 2018 at 10:47:12AM +0800, [email protected] wrote:
> From: Changbin Du <[email protected]>
>
> 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 <[email protected]>
> ---
> 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

2018-04-08 07:25:48

by Du, Changbin

[permalink] [raw]
Subject: Re: [PATCH] Documentation: fix reST markup error in driver-api/usb/typec.rst

On Sun, Apr 08, 2018 at 09:19:58AM +0200, Greg KH wrote:
> On Sun, Apr 08, 2018 at 10:47:12AM +0800, [email protected] wrote:
> > From: Changbin Du <[email protected]>
> >
> > 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 <[email protected]>
> > ---
> > 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.
>
No problem. Thanks for your quick checking!

> greg k-h

--
Thanks,
Changbin Du