On Fri, Apr 06, 2018 at 10:30:10AM +0200, Greg KH wrote: > On Fri, Apr 06, 2018 at 11:15:55AM +0300, Heikki Krogerus wrote: > > On Fri, Apr 06, 2018 at 09:57:34AM +0200, Greg KH wrote: > > > On Fri, Apr 06, 2018 at 10:51:09AM +0300, Heikki Krogerus wrote: > > > > On Fri, Apr 06, 2018 at 12:38:42PM +0900, Masanari Iida wrote: > > > > > After merge following patch during 4.17 merger period, > > > > > make xmldocs start to fail with error. > > > > > > > > > > [bdecb33af34f79cbfbb656661210f77c8b8b5b5f] > > > > > usb: typec: API for controlling USB Type-C Multiplexers > > > > > > > > > > Error messages. > > > > > reST markup error: > > > > > /home/iida/Repo/linux-2.6/Documentation/driver-api/usb/typec.rst:215: > > > > > (SEVERE/4) Unexpected section title or transition. > > > > > > > > > > ------------------------ > > > > > Documentation/Makefile:93: recipe for target 'xmldocs' failed > > > > > make[1]: *** [xmldocs] Error 1 > > > > > Makefile:1527: recipe for target 'xmldocs' failed > > > > > make: *** [xmldocs] Error 2 > > > > > > > > > > $ > > > > > > > > > > An ascii graphic in typec.rst cause the error. > > > > > > > > Thanks for the report. I'm going to propose that we fix this by > > > > marking the ascii art as comment: > > > > > > > > diff --git a/Documentation/driver-api/usb/typec.rst > > > > b/Documentation/driver-api/usb/typec.rst > > > > index feb31946490b..972c11bf4141 100644 > > > > --- a/Documentation/driver-api/usb/typec.rst > > > > +++ b/Documentation/driver-api/usb/typec.rst > > > > @@ -212,7 +212,7 @@ port drivers can use USB Role Class API with those. > > > > > > > > Illustration of the muxes behind a connector that supports an > > > > alternate mode: > > > > > > > > - ------------------------ > > > > +.. ------------------------ > > > > | Connector | > > > > ------------------------ > > > > | | > > > > > > > > I hope that works. > > > > > > Try it and see! :) > > > > It will fix this issue. I was just wondering if use of ascii art is > > acceptable in general with the .rst files? But then again, why > > wouldn't it be. > > There are ways to do this, look at how the v4l2 and I think the drm > subsystems handle ascii art such that "real" drawings end up being > produced.
Thanks. I did not actually find anything else except use of tables and code-blocks in v4l documentation. Is that what you were referring? I was propsed to use something called "Literal Block" with ascii art. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks Unless you object, that's what I will use. Thanks, -- heikki -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
