All of lore.kernel.org
 help / color / mirror / Atom feed
From: Dmitry Torokhov <dmitry.torokhov@gmail.com>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes
Date: Mon, 17 Apr 2017 20:11:27 -0700	[thread overview]
Message-ID: <20170418031127.GC39414@dtor-ws> (raw)
In-Reply-To: <b57d98d83423cb866dfe09defb11491689788b64.1492432818.git.mchehab@s-opensource.com>

On Mon, Apr 17, 2017 at 09:46:14AM -0300, Mauro Carvalho Chehab wrote:
> 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 <mchehab@s-opensource.com>

Applied, thank you.

> ---
>  Documentation/input/devices/xpad.rst | 51 ++++++++++++++++++------------------
>  1 file changed, 25 insertions(+), 26 deletions(-)
> 
> 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
> -- 
> 2.9.3
> 

-- 
Dmitry

  reply	other threads:[~2017-04-18  3:11 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-17 12:46 [PATCH 0/4] Some documentation fixes Mauro Carvalho Chehab
2017-04-17 12:46 ` [PATCH 1/4] input: xpad.rst: usb/devices is now at /sys/kernel/debug/ Mauro Carvalho Chehab
2017-04-18  3:11   ` Dmitry Torokhov
2017-04-17 12:46 ` [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes Mauro Carvalho Chehab
2017-04-18  3:11   ` Dmitry Torokhov [this message]
2017-04-17 12:46 ` [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb Mauro Carvalho Chehab
2017-04-18  3:11   ` Dmitry Torokhov
2017-04-17 12:46 ` [PATCH 4/4] [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170418031127.GC39414@dtor-ws \
    --to=dmitry.torokhov@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=mchehab@s-opensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.