Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1624662 > unrolled thread
| Started by | Mauro Carvalho Chehab <mchehab@s-opensource.com> |
|---|---|
| First post | 2017-04-17 14:50 +0200 |
| Last post | 2017-04-18 05:20 +0200 |
| Articles | 5 — 2 participants |
Back to article view | Back to linux.kernel
[PATCH 0/4] Some documentation fixes Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-04-17 14:50 +0200
[PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-04-17 14:50 +0200
Re: [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes Dmitry Torokhov <dmitry.torokhov@gmail.com> - 2017-04-18 05:20 +0200
[PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-04-17 14:50 +0200
Re: [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb Dmitry Torokhov <dmitry.torokhov@gmail.com> - 2017-04-18 05:20 +0200
| From | Mauro Carvalho Chehab <mchehab@s-opensource.com> |
|---|---|
| Date | 2017-04-17 14:50 +0200 |
| Subject | [PATCH 0/4] Some documentation fixes |
| Message-ID | <txegp-Gs-7@gated-at.bofh.it> |
This patch series address a few issues at the documentation, after
applying this patch series:
https://lkml.org/lkml/2017/4/16/2
The first patch solves a limitation with Sphinx and literal blocks
inside a footnote.
The next two patches fix issues with xpad.rst documentation, with
mentions /proc/bus/usb/, with used to be part of usbfs. When usbfs
got removed, the old location changed. So, update accordingly.
The final patch is RFC: it adds the uapi input.h file to the
documentation and groups the kAPI documentation generated from the
source code together with the kAPI part of the linux-input book.
We need to discuss it with documentation maintainers, to get an
agreement if this is the best way to handle it.
Mauro Carvalho Chehab (4):
input: xpad.rst: usb/devices is now at /sys/kernel/debug/
input: xpad.rst: Don't use literal blocks inside footnotes
input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb
[RFC] input: add kAPI and uAPI kernel-doc stuff at the input book
Documentation/driver-api/iio/intro.rst | 4 +-
Documentation/driver-api/index.rst | 1 -
Documentation/input/devices/xpad.rst | 53 +++++++++++-----------
Documentation/input/input_kapi.rst | 1 +
.../input.rst => input/input_kapi_symbols.rst} | 6 ++-
Documentation/input/input_uapi.rst | 1 +
Documentation/input/input_uapi_symbols.rst | 4 ++
7 files changed, 38 insertions(+), 32 deletions(-)
rename Documentation/{driver-api/input.rst => input/input_kapi_symbols.rst} (93%)
create mode 100644 Documentation/input/input_uapi_symbols.rst
--
2.9.3
[toc] | [next] | [standalone]
| From | Mauro Carvalho Chehab <mchehab@s-opensource.com> |
|---|---|
| Date | 2017-04-17 14:50 +0200 |
| Subject | [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes |
| Message-ID | <txegp-Gs-11@gated-at.bofh.it> |
| In reply to | #1624662 |
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> --- 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
[toc] | [prev] | [next] | [standalone]
| From | Dmitry Torokhov <dmitry.torokhov@gmail.com> |
|---|---|
| Date | 2017-04-18 05:20 +0200 |
| Subject | Re: [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes |
| Message-ID | <txrQl-Wj-7@gated-at.bofh.it> |
| In reply to | #1624663 |
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
[toc] | [prev] | [next] | [standalone]
| From | Mauro Carvalho Chehab <mchehab@s-opensource.com> |
|---|---|
| Date | 2017-04-17 14:50 +0200 |
| Subject | [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb |
| Message-ID | <txegq-Gs-17@gated-at.bofh.it> |
| In reply to | #1624662 |
xpad.rst requests a dump of the USB description, as found on the USB character device. When we got rid of usbfs, its location change. Update it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> --- Documentation/input/devices/xpad.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/input/devices/xpad.rst b/Documentation/input/devices/xpad.rst index c7c4e154bd34..3c74c185be7d 100644 --- a/Documentation/input/devices/xpad.rst +++ b/Documentation/input/devices/xpad.rst @@ -89,7 +89,7 @@ HOWEVER if you have an unknown dance pad not listed below, it will not work UNLESS you set "dpad_to_buttons" to 1 in the module configuration. PLEASE, if you have an unknown controller, email Dom <binary1230@yahoo.com> with -a dump from /proc/bus/usb and a description of the pad (manufacturer, country, +a dump from /dev/bus/usb and a description of the pad (manufacturer, country, whether it is a dance pad or normal controller) so that we can add your pad to the list of supported devices, ensuring that it will work out of the box in the future. -- 2.9.3
[toc] | [prev] | [next] | [standalone]
| From | Dmitry Torokhov <dmitry.torokhov@gmail.com> |
|---|---|
| Date | 2017-04-18 05:20 +0200 |
| Subject | Re: [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb |
| Message-ID | <txrQl-Wj-1@gated-at.bofh.it> |
| In reply to | #1624665 |
Hi Mauro, On Mon, Apr 17, 2017 at 09:46:15AM -0300, Mauro Carvalho Chehab wrote: > xpad.rst requests a dump of the USB description, as found > on the USB character device. When we got rid of usbfs, > its location change. Update it. I have not heard from Dom ever so I think the best option is to remove this entire paragraph. > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> > --- > Documentation/input/devices/xpad.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/input/devices/xpad.rst b/Documentation/input/devices/xpad.rst > index c7c4e154bd34..3c74c185be7d 100644 > --- a/Documentation/input/devices/xpad.rst > +++ b/Documentation/input/devices/xpad.rst > @@ -89,7 +89,7 @@ HOWEVER if you have an unknown dance pad not listed below, it will not > work UNLESS you set "dpad_to_buttons" to 1 in the module configuration. > > PLEASE, if you have an unknown controller, email Dom <binary1230@yahoo.com> with > -a dump from /proc/bus/usb and a description of the pad (manufacturer, country, > +a dump from /dev/bus/usb and a description of the pad (manufacturer, country, > whether it is a dance pad or normal controller) so that we can add your pad > to the list of supported devices, ensuring that it will work out of the > box in the future. > -- > 2.9.3 > -- Dmitry
[toc] | [prev] | [standalone]
Back to top | Article view | linux.kernel
csiph-web