linux-kernel - Re: make xmldocs failed with error after 4.17 merge period

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20180406075109.GA21589@kuha.fi.intel.com>
Date:   Fri, 6 Apr 2018 10:51:09 +0300
From:   Heikki Krogerus <heikki.krogerus@...ux.intel.com>
To:     Masanari Iida <standby24x7@...il.com>
Cc:     linux-kernel@...r.kernel.org,
        linux-doc <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Greg KH <gregkh@...uxfoundation.org>, linux-usb@...r.kernel.org
Subject: Re: make xmldocs failed with error after 4.17 merge period

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.


Br,

-- 
heikki