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: [36/57] docs: usb: convert documents to ReST From: Mauro Carvalho Chehab Message-Id: <20190416084328.380de91e@coco.lan> Date: Tue, 16 Apr 2019 08:43:28 -0300 To: Felipe Balbi Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Greg Kroah-Hartman , linux-usb@vger.kernel.org List-ID: RW0gVHVlLCAxNiBBcHIgMjAxOSAwOToxMjozMiArMDMwMApGZWxpcGUgQmFsYmkgPGZlbGlwZS5i YWxiaUBsaW51eC5pbnRlbC5jb20+IGVzY3JldmV1OgoKPiBNYXVybyBDYXJ2YWxobyBDaGVoYWIg PG1jaGVoYWIrc2Ftc3VuZ0BrZXJuZWwub3JnPiB3cml0ZXM6Cj4gCj4gPiBDb252ZXJ0IFVTQiBk b2N1bWVudHMgdG8gUmVTVCwgaW4gb3JkZXIgdG8gcHJlcGFyZSBmb3IgYWRkaW5nIGl0Cj4gPiB0 byB0aGUga2VybmVsIEFQSSBib29rLCBhcyBtb3N0IG9mIHRoZSBzdHVmZiB0aGVyZSBhcmUgZHJp dmVyIG9yCj4gPiBzdWJzeXN0ZW0tcmVsYXRlZC4KPiA+Cj4gPiBTaWduZWQtb2ZmLWJ5OiBNYXVy byBDYXJ2YWxobyBDaGVoYWIgPG1jaGVoYWIrc2Ftc3VuZ0BrZXJuZWwub3JnPgo+ID4gLS0tCj4g PiAgRG9jdW1lbnRhdGlvbi91c2IvV1VTQi1EZXNpZ24tb3ZlcnZpZXcudHh0IHwgIDU2ICstCj4g PiAgRG9jdW1lbnRhdGlvbi91c2IvYWNtLnR4dCAgICAgICAgICAgICAgICAgIHwgMTU2ICsrKy0t LQo+ID4gIERvY3VtZW50YXRpb24vdXNiL2F1dGhvcml6YXRpb24udHh0ICAgICAgICB8ICA3NSAr LS0KPiA+ICBEb2N1bWVudGF0aW9uL3VzYi9jaGlwaWRlYS50eHQgICAgICAgICAgICAgfCAxMDEg KystLQo+ID4gIERvY3VtZW50YXRpb24vdXNiL2R3YzMudHh0ICAgICAgICAgICAgICAgICB8ICAx MiArLQo+ID4gIERvY3VtZW50YXRpb24vdXNiL2VoY2kudHh0ICAgICAgICAgICAgICAgICB8ICA0 MiArLQo+ID4gIERvY3VtZW50YXRpb24vdXNiL2Z1bmN0aW9uZnMudHh0ICAgICAgICAgICB8ICAx NyArLQo+ID4gIERvY3VtZW50YXRpb24vdXNiL2dhZGdldC10ZXN0aW5nLnR4dCAgICAgICB8IDYw OSArKysrKysrKysrKystLS0tLS0tLS0KPiA+ICBEb2N1bWVudGF0aW9uL3VzYi9nYWRnZXRfY29u ZmlnZnMudHh0ICAgICAgfCAzMDIgKysrKystLS0tLQo+ID4gIERvY3VtZW50YXRpb24vdXNiL2dh ZGdldF9oaWQudHh0ICAgICAgICAgICB8IDE3NSArKystLS0KPiA+ICBEb2N1bWVudGF0aW9uL3Vz Yi9nYWRnZXRfbXVsdGkudHh0ICAgICAgICAgfCAgNDMgKy0KPiA+ICBEb2N1bWVudGF0aW9uL3Vz Yi9nYWRnZXRfcHJpbnRlci50eHQgICAgICAgfCAxNTUgKysrLS0tCj4gPiAgRG9jdW1lbnRhdGlv bi91c2IvZ2FkZ2V0X3NlcmlhbC50eHQgICAgICAgIHwgIDczICstLQo+ID4gIERvY3VtZW50YXRp b24vdXNiL2l1dV9waG9lbml4LnR4dCAgICAgICAgICB8ICAzNCArLQo+ID4gIERvY3VtZW50YXRp b24vdXNiL21hc3Mtc3RvcmFnZS50eHQgICAgICAgICB8ICAxOSArLQo+ID4gIERvY3VtZW50YXRp b24vdXNiL21pc2NfdXNic2V2c2VnLnR4dCAgICAgICB8ICAgOSArLQo+ID4gIERvY3VtZW50YXRp b24vdXNiL210b3VjaHVzYi50eHQgICAgICAgICAgICB8ICA0MiArLQo+ID4gIERvY3VtZW50YXRp b24vdXNiL29oY2kudHh0ICAgICAgICAgICAgICAgICB8ICAgNSArLQo+ID4gIERvY3VtZW50YXRp b24vdXNiL3Jpby50eHQgICAgICAgICAgICAgICAgICB8ICA4MyArLS0KPiA+ICBEb2N1bWVudGF0 aW9uL3VzYi91c2ItaGVscC50eHQgICAgICAgICAgICAgfCAgMjEgKy0KPiA+ICBEb2N1bWVudGF0 aW9uL3VzYi91c2Itc2VyaWFsLnR4dCAgICAgICAgICAgfCAyMDMgKysrKy0tLQo+ID4gIERvY3Vt ZW50YXRpb24vdXNiL3VzYmlwX3Byb3RvY29sLnR4dCAgICAgICB8IDU1MiArKysrKysrKysrLS0t LS0tLS0tCj4gPiAgRG9jdW1lbnRhdGlvbi91c2IvdXNibW9uLnR4dCAgICAgICAgICAgICAgIHwg MTAwICsrLS0gIAo+IAo+IHNob3VsZCB5b3UgY2hhbmdlIGV4dGVuc2lvbiB0byAucnN0IHdoaWxl IGF0IHRoYXQ/CgpJIGRpZCB0aGF0IG9uIGEgZmlyc3QgdmVyc2lvbiAobm90IHN1Ym1pdHRlZCk6 CgoJaHR0cHM6Ly9naXQubGludXh0di5vcmcvbWNoZWhhYi9leHBlcmltZW50YWwuZ2l0L2NvbW1p dC8/aD1hbGxfd2l0aF9pbmRleGVzJmlkPWQ3ZWVjNDY3OGRiZmViMWE0MGM1OGJjYTdhMTU3Yzhh NGMzOWZhMDQKCmJ1dCBJIG9wdGVkIGRvIHRoZSBwb3N0cG9uZSB0aGUgcmVuYW1lIHRvIGEgbmV3 IHNlcmllcyB5ZXQgdG8gYmUKc2VudC4KClRoZSBwcm9ibGVtIGlzIHRoYXQgcmVuYW1pbmcgaXQg d2lsbCBtYWtlIFNwaGlueCB0byB0cnkgdG8gYnVpbGQgdGhlbSwKY2F1c2luZyBsb3RzIG9mIHdh cm5pbmdzIGJlY2F1c2UgdGhleSB3b24ndCBiZSBpbnNpZGUgYW4gaW5kZXggZmlsZS4KQWRkaW5n IGluZGV4IHdvdWxkIHRvdWNoIERvY3VtZW50YXRpb24vaW5kZXggKG9yIERvY3VtZW50YXRpb24v ZHJpdmVycy1hcGkpLAp3aXRoIHdvdWxkIGNhdXNlIG1lcmdlIGNvbmZsaWN0cy4KCk9uY2UgdGhp cyBwYXRjaCBnZXRzIG1lcmdlZCB1cHN0cmVhbSwgYSByZW5hbWluZyBwYXRjaCBjYW4gaGFwcGVu CmFueXRpbWUuIEl0IHByb2JhYmx5IG1ha2VzIHNlbnNlIHRvIGRvIGFsbCByZW5hbWVzIGF0IG9u Y2UsIGxhdGUKYXQgYSBtZXJnZSB3aW5kb3cuCgoKVGhhbmtzLApNYXVybwo= From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_PASS, T_DKIMWL_WL_HIGH,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 74903C10F13 for ; Tue, 16 Apr 2019 11:43:42 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 473A420675 for ; Tue, 16 Apr 2019 11:43:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1555415022; bh=SDxhI0cHtXT8CGPUcKV1Fds9SU9qN3MLgWu8GoM6j7k=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=mbcLUjAwwx17nasYug5bxNG8RRdBzVRuhVN9yuUka3u/bdbUAurUyhUFLuK8mD4Yu KB8LLI45kK1r5gF35jm3EBSSxl3VkGwmG+xwFKxGSVDZzzXK/ekJfX8pNzH0vCchqe vDwnxphpUGehoCy4DA53iogW0/qeHDXP05rX1bKw= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729154AbfDPLnh (ORCPT ); Tue, 16 Apr 2019 07:43:37 -0400 Received: from casper.infradead.org ([85.118.1.10]:58130 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728706AbfDPLnh (ORCPT ); Tue, 16 Apr 2019 07:43:37 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To:From:Date:Sender :Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=pwSiZYvIqAnueGaDNcL1fXNSQ+1wKaAhSA0jh0cQoN8=; b=B5m/0kf20v9afSgg/Mw50xX6cA DBKW6+r9nqzeoNLM4VcN6NM7+FvgNAqMUJga8h2OM1O+f1XwtA0tNd2WeDRwDMGJIQh6nL13QCoyC w1/und9MnSspC/R+QrNtlH22Zqq1ANMX05mUx9NGct/+M/B73554xVND0+5OBo9pWoW3SF4a++QBG cYJvdNEZi7h6PF7DB/U0QQvSAsfv2OboOQZYsgQBLzwXpk3Y3hoJySA24tdrm1W8z+MRmMISGinEK cUaiNe+up+6+6oGl/r4oCHnQw9yiVqaU8Sp3at0Y3igD/SXHPFtjdN0bKPRqgv2X66IoRGdJK0HmS xBmJZSjw==; Received: from 177.205.118.176.dynamic.adsl.gvt.net.br ([177.205.118.176] helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hGMUv-00082H-2W; Tue, 16 Apr 2019 11:43:33 +0000 Date: Tue, 16 Apr 2019 08:43:28 -0300 From: Mauro Carvalho Chehab To: Felipe Balbi Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Greg Kroah-Hartman , linux-usb@vger.kernel.org Subject: Re: [PATCH 36/57] docs: usb: convert documents to ReST Message-ID: <20190416084328.380de91e@coco.lan> In-Reply-To: <874l6ya373.fsf@linux.intel.com> References: <874l6ya373.fsf@linux.intel.com> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit Sender: linux-usb-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-usb@vger.kernel.org Message-ID: <20190416114328.c6JrDX_WLCRoNDy2L4BvM6phtBXafsxvfQ5MLcf_5C8@z> Em Tue, 16 Apr 2019 09:12:32 +0300 Felipe Balbi escreveu: > Mauro Carvalho Chehab writes: > > > Convert USB documents to ReST, in order to prepare for adding it > > to the kernel API book, as most of the stuff there are driver or > > subsystem-related. > > > > Signed-off-by: Mauro Carvalho Chehab > > --- > > Documentation/usb/WUSB-Design-overview.txt | 56 +- > > Documentation/usb/acm.txt | 156 +++--- > > Documentation/usb/authorization.txt | 75 +-- > > Documentation/usb/chipidea.txt | 101 ++-- > > Documentation/usb/dwc3.txt | 12 +- > > Documentation/usb/ehci.txt | 42 +- > > Documentation/usb/functionfs.txt | 17 +- > > Documentation/usb/gadget-testing.txt | 609 ++++++++++++--------- > > Documentation/usb/gadget_configfs.txt | 302 +++++----- > > Documentation/usb/gadget_hid.txt | 175 +++--- > > Documentation/usb/gadget_multi.txt | 43 +- > > Documentation/usb/gadget_printer.txt | 155 +++--- > > Documentation/usb/gadget_serial.txt | 73 +-- > > Documentation/usb/iuu_phoenix.txt | 34 +- > > Documentation/usb/mass-storage.txt | 19 +- > > Documentation/usb/misc_usbsevseg.txt | 9 +- > > Documentation/usb/mtouchusb.txt | 42 +- > > Documentation/usb/ohci.txt | 5 +- > > Documentation/usb/rio.txt | 83 +-- > > Documentation/usb/usb-help.txt | 21 +- > > Documentation/usb/usb-serial.txt | 203 ++++--- > > Documentation/usb/usbip_protocol.txt | 552 ++++++++++--------- > > Documentation/usb/usbmon.txt | 100 ++-- > > should you change extension to .rst while at that? I did that on a first version (not submitted): https://git.linuxtv.org/mchehab/experimental.git/commit/?h=all_with_indexes&id=d7eec4678dbfeb1a40c58bca7a157c8a4c39fa04 but I opted do the postpone the rename to a new series yet to be sent. The problem is that renaming it will make Sphinx to try to build them, causing lots of warnings because they won't be inside an index file. Adding index would touch Documentation/index (or Documentation/drivers-api), with would cause merge conflicts. Once this patch gets merged upstream, a renaming patch can happen anytime. It probably makes sense to do all renames at once, late at a merge window. Thanks, Mauro