From patchwork Sun Apr 16 15:25:43 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 9683023 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id BD7E860326 for ; Sun, 16 Apr 2017 15:25:59 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id ACA6427DA4 for ; Sun, 16 Apr 2017 15:25:59 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 9E48527F54; Sun, 16 Apr 2017 15:25:59 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0551927DA4 for ; Sun, 16 Apr 2017 15:25:55 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756200AbdDPPZy (ORCPT ); Sun, 16 Apr 2017 11:25:54 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:47629 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1755912AbdDPPZx (ORCPT ); Sun, 16 Apr 2017 11:25:53 -0400 Received: from localhost (localhost [127.0.0.1]) by osg.samsung.com (Postfix) with ESMTP id E98A4A05F0; Sun, 16 Apr 2017 15:26:17 +0000 (UTC) X-Virus-Scanned: amavisd-new at osg.samsung.com Received: from osg.samsung.com ([127.0.0.1]) by localhost (s-opensource.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ajeAcJrUdtdG; Sun, 16 Apr 2017 15:26:13 +0000 (UTC) Received: from vento.lan (177.17.234.63.dynamic.adsl.gvt.net.br [177.17.234.63]) by osg.samsung.com (Postfix) with ESMTPSA id EAF01A05ED; Sun, 16 Apr 2017 15:26:11 +0000 (UTC) Date: Sun, 16 Apr 2017 12:25:43 -0300 From: Mauro Carvalho Chehab To: Dmitry Torokhov , Jonathan Corbet Cc: linux-input@vger.kernel.org, Mauro Carvalho Chehab , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Vojtech Pavlik Subject: Re: [PATCH 7/8] Input: docs - split input docs into kernel- and user-facing (resend) Message-ID: <20170416115053.233b5a37@vento.lan> In-Reply-To: <20170416110813.66a4ba64@vento.lan> References: <20170416051145.13618-1-dmitry.torokhov@gmail.com> <20170416051145.13618-7-dmitry.torokhov@gmail.com> <20170416110813.66a4ba64@vento.lan> Organization: Samsung X-Mailer: Claws Mail 3.14.1 (GTK+ 2.24.31; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Sender: linux-input-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Em Sun, 16 Apr 2017 11:08:13 -0300 Mauro Carvalho Chehab escreveu: > Hi Dmitry, > > Em Sat, 15 Apr 2017 22:11:44 -0700 > Dmitry Torokhov escreveu: > > > Split input documentation into several groups: kernel- and user-facing, and > > notes about individual device drivers. Move device drivers docs into a > > separate subdirectory. > > I reviewed and tested Sphinx generation for this patch series. > Thinks are a way better organized now. Good work! > > I got just a minor nitpick for HTML generation (see below). > > > However, building PDF documentation now hits an error, with Sphinx 1.4.9: > > Markup is unsupported in LaTeX: > input/devices/xpad:209: literal blocks in footnotes are not supported by LaTeX > > It seems it didn't like to have literal blocks inside footnotes: > > .. [4] /proc/bus/usb/devices - dump from InterAct PowerPad Pro (Germany): > > :: > > T: Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#= 5 Spd=12 MxCh= 0 > D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs= 1 > P: Vendor=05fd ProdID=107a Rev= 1.00 > C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA > I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none) > E: Ad=81(I) Atr=03(Int.) MxPS= 32 Ivl= 10ms > E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl= 10ms > > > I'll see if I can find a way to fix this issue. The enclosed patch should fix it. It should come after the one that replaces /proc/bus/usb/devices to /sys/kernel/debug/usb/devices. It also fixes the last reference to the last URL. PS.: resent, this time with the patch attached) Thanks, Mauro [PATCH] input: xpad.rst: Don't use literal blocks inside footnotes Unfortunately, Sphinx (or LaTeX) can't handle literal blocks inside footnotes. So, just use normal text for the two literal code-blocks that documents the output of /sys/kernel/debug/usb/devices for xpad devices. Signed-off-by: Mauro Carvalho Chehab --- To unsubscribe from this list: send the line "unsubscribe linux-input" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html diff --git a/Documentation/input/devices/xpad.rst b/Documentation/input/devices/xpad.rst index e19669fe5a80..c7c4e154bd34 100644 --- a/Documentation/input/devices/xpad.rst +++ b/Documentation/input/devices/xpad.rst @@ -138,15 +138,37 @@ Driver Installation Once you have the adapter cable, if needed, and the controller connected the xpad module should be auto loaded. To confirm you can cat -/sys/kernel/debug/usb/devices. There should be an entry like the one at the end [4]_. +/sys/kernel/debug/usb/devices. There should be an entry like those: +.. code-block:: none + :caption: dump from InterAct PowerPad Pro (Germany) + + T: Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#= 5 Spd=12 MxCh= 0 + D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs= 1 + P: Vendor=05fd ProdID=107a Rev= 1.00 + C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA + I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none) + E: Ad=81(I) Atr=03(Int.) MxPS= 32 Ivl= 10ms + E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl= 10ms + +.. code-block:: none + :caption: dump from Redoctane Xbox Dance Pad (US) + + T: Bus=01 Lev=02 Prnt=09 Port=00 Cnt=01 Dev#= 10 Spd=12 MxCh= 0 + D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 + P: Vendor=0c12 ProdID=8809 Rev= 0.01 + S: Product=XBOX DDR + C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA + I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=xpad + E: Ad=82(I) Atr=03(Int.) MxPS= 32 Ivl=4ms + E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl=4ms Supported Controllers ===================== For a full list of supported controllers and associated vendor and product -IDs see the xpad_device[] array[6]. +IDs see the xpad_device[] array\ [4]_. As of the historic version 0.0.6 (2006-10-10) the following devices were supported:: @@ -202,30 +224,7 @@ References .. [1] http://euc.jp/periphs/xbox-controller.ja.html (ITO Takayuki) .. [2] http://xpad.xbox-scene.com/ .. [3] http://www.markosweb.com/www/xboxhackz.com/ -.. [4] /sys/kernel/debug/usb/devices - dump from InterAct PowerPad Pro (Germany): - - :: - - T: Bus=01 Lev=03 Prnt=04 Port=00 Cnt=01 Dev#= 5 Spd=12 MxCh= 0 - D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS=32 #Cfgs= 1 - P: Vendor=05fd ProdID=107a Rev= 1.00 - C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA - I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=(none) - E: Ad=81(I) Atr=03(Int.) MxPS= 32 Ivl= 10ms - E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl= 10ms -.. [5] /sys/kernel/debug/usb/devices - dump from Redoctane Xbox Dance Pad (US): - - :: - - T: Bus=01 Lev=02 Prnt=09 Port=00 Cnt=01 Dev#= 10 Spd=12 MxCh= 0 - D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 - P: Vendor=0c12 ProdID=8809 Rev= 0.01 - S: Product=XBOX DDR - C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA - I: If#= 0 Alt= 0 #EPs= 2 Cls=58(unk. ) Sub=42 Prot=00 Driver=xpad - E: Ad=82(I) Atr=03(Int.) MxPS= 32 Ivl=4ms - E: Ad=02(O) Atr=03(Int.) MxPS= 32 Ivl=4ms -.. [6] http://lxr.free-electrons.com/ident?i=xpad_device +.. [4] http://lxr.free-electrons.com/ident?i=xpad_device Historic Edits