Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art
On Wed, Apr 25, 2018 at 04:47:01PM +0300, Jani Nikula wrote: > On Fri, 06 Apr 2018, Heikki Krogeruswrote: > > Using reStructuredText literal-block element with ascii-art. > > That prevents the ascii art from being processed as > > reStructuredText. > > > > Reported-by: Masanari Iida > > Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C > > Multiplexers") > > Signed-off-by: Heikki Krogerus > > 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. This is in my tree, will go to Linus in a day or so. thanks, greg k-h -- To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art
On Wed, 25 Apr 2018 16:47:01 +0300 Jani Nikulawrote: > On Fri, 06 Apr 2018, Heikki Krogerus wrote: > > Using reStructuredText literal-block element with ascii-art. > > That prevents the ascii art from being processed as > > reStructuredText. > > > > Reported-by: Masanari Iida > > Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C > > Multiplexers") > > Signed-off-by: Heikki Krogerus > > 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 To: changbin...@intel.com Cc: cor...@lwn.net, linux-...@vger.kernel.org, linux-ker...@vger.kernel.org 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-ow...@vger.kernel.org On Sun, Apr 08, 2018 at 10:47:12AM +0800, changbin...@intel.com wrote: > From: Changbin Du > > 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 > --- > 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 -- To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art
On Fri, 06 Apr 2018, Heikki Krogeruswrote: > Using reStructuredText literal-block element with ascii-art. > That prevents the ascii art from being processed as > reStructuredText. > > Reported-by: Masanari Iida > Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C > Multiplexers") > Signed-off-by: Heikki Krogerus 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. Thanks, Jani. > --- > Changed since v1: > - Using literal-block element instead of comment > - Subject in v1 was "Documentation: typec.rst: Mark ascii art as a comment" > --- > 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 feb31946490b..48ff58095f11 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 | -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art
On Fri, 06 Apr 2018, Heikki Krogeruswrote: > Using reStructuredText literal-block element with ascii-art. > That prevents the ascii art from being processed as > reStructuredText. > > Reported-by: Masanari Iida > Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C > Multiplexers") > Signed-off-by: Heikki Krogerus Reviewed-and-tested-by: Jani Nikula > --- > Changed since v1: > - Using literal-block element instead of comment > - Subject in v1 was "Documentation: typec.rst: Mark ascii art as a comment" > --- > 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 feb31946490b..48ff58095f11 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 | -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art
Using reStructuredText literal-block element with ascii-art. That prevents the ascii art from being processed as reStructuredText. Reported-by: Masanari IidaFixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers") Signed-off-by: Heikki Krogerus --- Changed since v1: - Using literal-block element instead of comment - Subject in v1 was "Documentation: typec.rst: Mark ascii art as a comment" --- 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 feb31946490b..48ff58095f11 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.16.3 -- To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html