From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-4.8 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, RCVD_IN_DNSWL_HI,T_RP_MATCHES_RCVD autolearn=ham autolearn_force=no version=3.4.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 8BAF37DD32 for ; Fri, 6 Apr 2018 09:11:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751434AbeDFJLb (ORCPT ); Fri, 6 Apr 2018 05:11:31 -0400 Received: from mga07.intel.com ([134.134.136.100]:63446 "EHLO mga07.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751389AbeDFJLa (ORCPT ); Fri, 6 Apr 2018 05:11:30 -0400 X-Amp-Result: UNSCANNABLE X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 06 Apr 2018 02:11:29 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.48,414,1517904000"; d="scan'208";a="44592560" Received: from kuha.fi.intel.com ([10.237.72.189]) by fmsmga001.fm.intel.com with SMTP; 06 Apr 2018 02:11:27 -0700 Received: by kuha.fi.intel.com (sSMTP sendmail emulation); Fri, 06 Apr 2018 12:11:26 +0300 Date: Fri, 6 Apr 2018 12:11:26 +0300 From: Heikki Krogerus To: Greg KH Cc: Masanari Iida , linux-kernel@vger.kernel.org, linux-doc , Jonathan Corbet , linux-usb@vger.kernel.org Subject: Re: make xmldocs failed with error after 4.17 merge period Message-ID: <20180406091126.GC21589@kuha.fi.intel.com> References: <20180406075109.GA21589@kuha.fi.intel.com> <20180406075734.GA16728@kroah.com> <20180406081555.GB21589@kuha.fi.intel.com> <20180406083010.GA20174@kroah.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180406083010.GA20174@kroah.com> User-Agent: Mutt/1.9.2 (2017-12-15) Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 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 majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html From mboxrd@z Thu Jan 1 00:00:00 1970 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Subject: make xmldocs failed with error after 4.17 merge period From: Heikki Krogerus Message-Id: <20180406091126.GC21589@kuha.fi.intel.com> Date: Fri, 6 Apr 2018 12:11:26 +0300 To: Greg KH Cc: Masanari Iida , linux-kernel@vger.kernel.org, linux-doc , Jonathan Corbet , linux-usb@vger.kernel.org List-ID: T24gRnJpLCBBcHIgMDYsIDIwMTggYXQgMTA6MzA6MTBBTSArMDIwMCwgR3JlZyBLSCB3cm90ZToK PiBPbiBGcmksIEFwciAwNiwgMjAxOCBhdCAxMToxNTo1NUFNICswMzAwLCBIZWlra2kgS3JvZ2Vy dXMgd3JvdGU6Cj4gPiBPbiBGcmksIEFwciAwNiwgMjAxOCBhdCAwOTo1NzozNEFNICswMjAwLCBH cmVnIEtIIHdyb3RlOgo+ID4gPiBPbiBGcmksIEFwciAwNiwgMjAxOCBhdCAxMDo1MTowOUFNICsw MzAwLCBIZWlra2kgS3JvZ2VydXMgd3JvdGU6Cj4gPiA+ID4gT24gRnJpLCBBcHIgMDYsIDIwMTgg YXQgMTI6Mzg6NDJQTSArMDkwMCwgTWFzYW5hcmkgSWlkYSB3cm90ZToKPiA+ID4gPiA+IEFmdGVy IG1lcmdlIGZvbGxvd2luZyBwYXRjaCBkdXJpbmcgNC4xNyBtZXJnZXIgcGVyaW9kLAo+ID4gPiA+ ID4gbWFrZSB4bWxkb2NzIHN0YXJ0IHRvIGZhaWwgd2l0aCBlcnJvci4KPiA+ID4gPiA+IAo+ID4g PiA+ID4gIFtiZGVjYjMzYWYzNGY3OWNiZmJiNjU2NjYxMjEwZjc3YzhiOGI1YjVmXQo+ID4gPiA+ ID4gdXNiOiB0eXBlYzogQVBJIGZvciBjb250cm9sbGluZyBVU0IgVHlwZS1DIE11bHRpcGxleGVy cwo+ID4gPiA+ID4gCj4gPiA+ID4gPiBFcnJvciBtZXNzYWdlcy4KPiA+ID4gPiA+IHJlU1QgbWFy a3VwIGVycm9yOgo+ID4gPiA+ID4gL2hvbWUvaWlkYS9SZXBvL2xpbnV4LTIuNi9Eb2N1bWVudGF0 aW9uL2RyaXZlci1hcGkvdXNiL3R5cGVjLnJzdDoyMTU6Cj4gPiA+ID4gPiAoU0VWRVJFLzQpIFVu ZXhwZWN0ZWQgc2VjdGlvbiB0aXRsZSBvciB0cmFuc2l0aW9uLgo+ID4gPiA+ID4gCj4gPiA+ID4g PiAtLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KPiA+ID4gPiA+IERvY3VtZW50YXRpb24vTWFrZWZp bGU6OTM6IHJlY2lwZSBmb3IgdGFyZ2V0ICd4bWxkb2NzJyBmYWlsZWQKPiA+ID4gPiA+IG1ha2Vb MV06ICoqKiBbeG1sZG9jc10gRXJyb3IgMQo+ID4gPiA+ID4gTWFrZWZpbGU6MTUyNzogcmVjaXBl IGZvciB0YXJnZXQgJ3htbGRvY3MnIGZhaWxlZAo+ID4gPiA+ID4gbWFrZTogKioqIFt4bWxkb2Nz XSBFcnJvciAyCj4gPiA+ID4gPiAKPiA+ID4gPiA+ICQKPiA+ID4gPiA+IAo+ID4gPiA+ID4gQW4g YXNjaWkgZ3JhcGhpYyBpbiB0eXBlYy5yc3QgY2F1c2UgdGhlIGVycm9yLgo+ID4gPiA+IAo+ID4g PiA+IFRoYW5rcyBmb3IgdGhlIHJlcG9ydC4gSSdtIGdvaW5nIHRvIHByb3Bvc2UgdGhhdCB3ZSBm aXggdGhpcyBieQo+ID4gPiA+IG1hcmtpbmcgdGhlIGFzY2lpIGFydCBhcyBjb21tZW50Ogo+ID4g PiA+IAo+ID4gPiA+IGRpZmYgLS1naXQgYS9Eb2N1bWVudGF0aW9uL2RyaXZlci1hcGkvdXNiL3R5 cGVjLnJzdCBiL0RvY3VtZW50YXRpb24vZHJpdmVyLWFwaS91c2IvdHlwZWMucnN0Cj4gPiA+ID4g aW5kZXggZmViMzE5NDY0OTBiLi45NzJjMTFiZjQxNDEgMTAwNjQ0Cj4gPiA+ID4gLS0tIGEvRG9j dW1lbnRhdGlvbi9kcml2ZXItYXBpL3VzYi90eXBlYy5yc3QKPiA+ID4gPiArKysgYi9Eb2N1bWVu dGF0aW9uL2RyaXZlci1hcGkvdXNiL3R5cGVjLnJzdAo+ID4gPiA+IEBAIC0yMTIsNyArMjEyLDcg QEAgcG9ydCBkcml2ZXJzIGNhbiB1c2UgVVNCIFJvbGUgQ2xhc3MgQVBJIHdpdGggdGhvc2UuCj4g PiA+ID4gCj4gPiA+ID4gIElsbHVzdHJhdGlvbiBvZiB0aGUgbXV4ZXMgYmVoaW5kIGEgY29ubmVj dG9yIHRoYXQgc3VwcG9ydHMgYW4gYWx0ZXJuYXRlIG1vZGU6Cj4gPiA+ID4gCj4gPiA+ID4gLSAg ICAgICAgICAgICAgICAgICAgIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQo+ID4gPiA+ICsuLiAg ICAgICAgICAgICAgICAgICAtLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KPiA+ID4gPiAgICAgICAg ICAgICAgICAgICAgICAgfCAgICAgICBDb25uZWN0b3IgICAgICB8Cj4gPiA+ID4gICAgICAgICAg ICAgICAgICAgICAgIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQo+ID4gPiA+ICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgfCAgICAgICAgIHwKPiA+ID4gPiAKPiA+ID4gPiBJIGhvcGUgdGhh dCB3b3Jrcy4KPiA+ID4gCj4gPiA+IFRyeSBpdCBhbmQgc2VlISAgOikKPiA+IAo+ID4gSXQgd2ls bCBmaXggdGhpcyBpc3N1ZS4gSSB3YXMganVzdCB3b25kZXJpbmcgaWYgdXNlIG9mIGFzY2lpIGFy dCBpcwo+ID4gYWNjZXB0YWJsZSBpbiBnZW5lcmFsIHdpdGggdGhlIC5yc3QgZmlsZXM/IEJ1dCB0 aGVuIGFnYWluLCB3aHkKPiA+IHdvdWxkbid0IGl0IGJlLgo+IAo+IFRoZXJlIGFyZSB3YXlzIHRv IGRvIHRoaXMsIGxvb2sgYXQgaG93IHRoZSB2NGwyIGFuZCBJIHRoaW5rIHRoZSBkcm0KPiBzdWJz eXN0ZW1zIGhhbmRsZSBhc2NpaSBhcnQgc3VjaCB0aGF0ICJyZWFsIiBkcmF3aW5ncyBlbmQgdXAg YmVpbmcKPiBwcm9kdWNlZC4KClRoYW5rcy4gSSBkaWQgbm90IGFjdHVhbGx5IGZpbmQgYW55dGhp bmcgZWxzZSBleGNlcHQgdXNlIG9mIHRhYmxlcyBhbmQKY29kZS1ibG9ja3MgaW4gdjRsIGRvY3Vt ZW50YXRpb24uIElzIHRoYXQgd2hhdCB5b3Ugd2VyZSByZWZlcnJpbmc/CgpJIHdhcyBwcm9wc2Vk IHRvIHVzZSBzb21ldGhpbmcgY2FsbGVkICJMaXRlcmFsIEJsb2NrIiB3aXRoIGFzY2lpIGFydC4K aHR0cDovL2RvY3V0aWxzLnNvdXJjZWZvcmdlLm5ldC9kb2NzL3JlZi9yc3QvcmVzdHJ1Y3R1cmVk dGV4dC5odG1sI2xpdGVyYWwtYmxvY2tzCgpVbmxlc3MgeW91IG9iamVjdCwgdGhhdCdzIHdoYXQg SSB3aWxsIHVzZS4KCgpUaGFua3MsCg== From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Google-Smtp-Source: AIpwx4+AyUJXQ7jUxyYZAeBOeJutOywWlRA2egPh8UvbUNQRh9GNzoW4T86cTcxgOOtlpLlvP3kz ARC-Seal: i=1; a=rsa-sha256; t=1523005915; cv=none; d=google.com; s=arc-20160816; b=caDnm8meoEgWu7y50/btR/w+xjbeKfPQLiDrqomhnzfED4yLqvoFdYkPiQlwXuAwoj DE+hOcQLiPfcC8qxD5xhqgM/oYInkg9VHkrtOiqmDcGMbJyS5BSMLSOIyulrYfSU8gDO QWBKnpLZXYqS6IdgprnTS4qIOS+g/6WRKOINlSAsIpNKSuKOSWTk4bk/7yq7aVUQiR3e hp408PAxrzT8Y9Ziokq/HNcAjneHN5blozjkkArk3D5iGJ9bgySz9Rj9KOkKWDfEHNFU slt/PWkfPFP920Cwqgp7r9jn8CEkkr0NswnRhP/Vi+9sZv2SWzVYVA5JHgDRR+o9mQKZ OKqQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=user-agent:in-reply-to:content-disposition:mime-version:references :message-id:subject:cc:to:from:date:arc-authentication-results; bh=JRhPfCbxgKBmsJ1pEF9+UseMQp6Q4SsEPctpTViIBIU=; b=IYH2dcjQBJ6NaX8jAgxUsZhg1izbnOUN9vhA62SCjvEmyRfdiqMaY8YV6TXBbShJeq updhn02nkf5ZqUTLypfi7nVZItrPZ/Zyz8XfUYzB9fYunN1zTQOQBSO0FZyRBGTf3O4l OXxijA9CkaU9NwUvyp/5lQktXZJIrsLiZhNtFprB+9waYGImVZ50+ystDcmpP7fF1f/h lyBVMfsqsEBTeHBvTzLGHdPN/WS8P9a0DjtdiRar+thY7g6Cm28m4f/HQ7zMiUCJxIB2 fY05XaJGzrhudpJoSs9g6XqDJd8S8i1wyOLz2mmGcMsjDdAKh0gMiIj6uisOt483Cdf6 pz7A== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of heikki.krogerus@linux.intel.com designates 192.55.52.93 as permitted sender) smtp.mailfrom=heikki.krogerus@linux.intel.com Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of heikki.krogerus@linux.intel.com designates 192.55.52.93 as permitted sender) smtp.mailfrom=heikki.krogerus@linux.intel.com X-Amp-Result: UNKNOWN X-Amp-Original-Verdict: FILE UNKNOWN X-Amp-File-Uploaded: False X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.48,414,1517904000"; d="scan'208";a="44592560" Date: Fri, 6 Apr 2018 12:11:26 +0300 From: Heikki Krogerus To: Greg KH Cc: Masanari Iida , linux-kernel@vger.kernel.org, linux-doc , Jonathan Corbet , linux-usb@vger.kernel.org Subject: Re: make xmldocs failed with error after 4.17 merge period Message-ID: <20180406091126.GC21589@kuha.fi.intel.com> References: <20180406075109.GA21589@kuha.fi.intel.com> <20180406075734.GA16728@kroah.com> <20180406081555.GB21589@kuha.fi.intel.com> <20180406083010.GA20174@kroah.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180406083010.GA20174@kroah.com> User-Agent: Mutt/1.9.2 (2017-12-15) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1596966487828993292?= X-GMAIL-MSGID: =?utf-8?q?1596987450523006122?= X-Mailing-List: linux-kernel@vger.kernel.org List-ID: 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