From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: linux-input@vger.kernel.org, Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Henrik Rydberg <rydberg@bitmath.org>,
Peter Hutterer <peter.hutterer@who-t.net>,
Markus Heiser <markus.heiser@darmarit.de>,
Henk Vergonet <Henk.Vergonet@gmail.com>,
usbb2k-api-dev@nongnu.org, Martin Kepplinger <martink@posteo.de>,
Ben Gamari <ben@smart-cactus.org>
Subject: [PATCH v2 00/33] Convert input documentation to ReST
Date: Tue, 4 Apr 2017 07:52:10 -0300 [thread overview]
Message-ID: <cover.1491302719.git.mchehab@s-opensource.com> (raw)
As I'm needing to touch some Input documentation, I took the time
to also convert the existing documents to ReST markup, building them
with Sphinx. The end result can be seen at:
http://www.infradead.org/~mchehab/kernel_docs/input/
Instead of placing the documentation under Documentation/driver-api, I opted
to keep them at Documentation/input. The rationale is that the documentation
there doesn't have only driver-api bits, but other things too.
Those patches are based on the linux-input tree, on its next branch:
git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input.git next
Please notice that I converted the two existing XFIG files there to SVG. As the
Documentation/sphinx/kfigure.py doesn't exist at the input tree, I opted
to use the ".. figure" tag to include the SVG files. This should be changed to
use the right extension, after merging upstream, but this should be a two line
patch that can be applied afterwards.
PS.: I didn't try to update the contents of the documentation int his series.
v2:
- Rebased on current upstream, fixing a conflict at input.txt;
- Added Peter Hutterer ack to event-codes.txt
Mauro Carvalho Chehab (33):
docs: Documentation/input/input: convert it to ReST format
docs: input/alps: convert it to ReST format
docs: input/amijoy: convert it to ReST format
docs: input/appletouch: convert it to ReST format
docs: input/atarikbd: convert it to ReST format
docs: input/bcm5974: convert it to ReST format
docs: input/cd32: convert it to ReST format
docs: input/cma3000_d0x: convert it to ReST format
docs: input/cs461x: convert it to ReST format
docs: input/elantech: convert it to ReST format
docs: input/event-codes: convert it to ReST format
docs: input/ff: convert it to ReST format
docs: input/gamepad: convert it to ReST format
docs: input/gameport-programming: convert it to ReST format
docs: input/gpio-tilt: convert it to ReST format
docs: input/iforce-protocol: convert it to ReST format
docs: input/input-programming: convert it to ReST format
docs: input/joystick-api: convert it to ReST format
docs: input/joystick: convert it to ReST format
docs: input/joystick-parport: convert it to ReST format
docs: input/multi-touch-protocol: convert it to ReST format
docs: input/notifier: convert it to ReST format
docs: input/ntrig: convert it to ReST format
docs: input/rotary-encoder: convert it to ReST format
docs: input/sentelic: convert it to ReST format
docs: input/userio: convert it to ReST format
docs: input/walkera0701: convert it to ReST format
docs: input/xpad: convert it to ReST format
docs: input/yealink: convert it to ReST format
docs-rst: create a book with Linux Input documentation
docs: input/shape: convert it from xfig to svg
docs: input/interactive: convert from xfig to svg
docs: ff.rst: use svg files instead of xfig
Documentation/conf.py | 2 +
Documentation/input/{alps.txt => alps.rst} | 43 +-
Documentation/input/{amijoy.txt => amijoy.rst} | 165 ++--
.../input/{appletouch.txt => appletouch.rst} | 33 +-
Documentation/input/{atarikbd.txt => atarikbd.rst} | 214 +++--
Documentation/input/{bcm5974.txt => bcm5974.rst} | 43 +-
Documentation/input/cd32.rst | 23 +
Documentation/input/cd32.txt | 19 -
.../input/{cma3000_d0x.txt => cma3000_d0x.rst} | 72 +-
Documentation/input/conf.py | 10 +
Documentation/input/{cs461x.txt => cs461x.rst} | 28 +-
.../input/{edt-ft5x06.txt => edt-ft5x06.rst} | 0
Documentation/input/{elantech.txt => elantech.rst} | 306 +++----
.../input/{event-codes.txt => event-codes.rst} | 132 ++-
Documentation/input/{ff.txt => ff.rst} | 205 +++--
Documentation/input/{gamepad.txt => gamepad.rst} | 43 +-
...rt-programming.txt => gameport-programming.rst} | 83 +-
Documentation/input/gpio-tilt.rst | 103 +++
Documentation/input/gpio-tilt.txt | 103 ---
Documentation/input/iforce-protocol.rst | 381 +++++++++
Documentation/input/iforce-protocol.txt | 258 ------
Documentation/input/index.rst | 77 ++
...input-programming.txt => input-programming.rst} | 253 +++---
Documentation/input/{input.txt => input.rst} | 238 +++---
Documentation/input/interactive.fig | 42 -
Documentation/input/interactive.svg | 24 +
.../input/{joystick-api.txt => joystick-api.rst} | 138 ++--
Documentation/input/joystick-parport.rst | 574 +++++++++++++
Documentation/input/joystick-parport.txt | 542 -------------
Documentation/input/{joystick.txt => joystick.rst} | 541 +++++++------
...touch-protocol.txt => multi-touch-protocol.rst} | 196 +++--
Documentation/input/{notifier.txt => notifier.rst} | 10 +-
Documentation/input/{ntrig.txt => ntrig.rst} | 49 +-
.../{rotary-encoder.txt => rotary-encoder.rst} | 74 +-
Documentation/input/sentelic.rst | 901 +++++++++++++++++++++
Documentation/input/sentelic.txt | 873 --------------------
Documentation/input/shape.fig | 65 --
Documentation/input/shape.svg | 39 +
Documentation/input/{userio.txt => userio.rst} | 79 +-
.../input/{walkera0701.txt => walkera0701.rst} | 53 +-
Documentation/input/{xpad.txt => xpad.rst} | 120 +--
Documentation/input/{yealink.txt => yealink.rst} | 164 ++--
42 files changed, 4046 insertions(+), 3272 deletions(-)
rename Documentation/input/{alps.txt => alps.rst} (95%)
rename Documentation/input/{amijoy.txt => amijoy.rst} (63%)
rename Documentation/input/{appletouch.txt => appletouch.rst} (81%)
rename Documentation/input/{atarikbd.txt => atarikbd.rst} (91%)
rename Documentation/input/{bcm5974.txt => bcm5974.rst} (55%)
create mode 100644 Documentation/input/cd32.rst
delete mode 100644 Documentation/input/cd32.txt
rename Documentation/input/{cma3000_d0x.txt => cma3000_d0x.rst} (67%)
create mode 100644 Documentation/input/conf.py
rename Documentation/input/{cs461x.txt => cs461x.rst} (87%)
rename Documentation/input/{edt-ft5x06.txt => edt-ft5x06.rst} (100%)
rename Documentation/input/{elantech.txt => elantech.rst} (88%)
rename Documentation/input/{event-codes.txt => event-codes.rst} (96%)
rename Documentation/input/{ff.txt => ff.rst} (62%)
rename Documentation/input/{gamepad.txt => gamepad.rst} (91%)
rename Documentation/input/{gameport-programming.txt => gameport-programming.rst} (85%)
create mode 100644 Documentation/input/gpio-tilt.rst
delete mode 100644 Documentation/input/gpio-tilt.txt
create mode 100644 Documentation/input/iforce-protocol.rst
delete mode 100644 Documentation/input/iforce-protocol.txt
create mode 100644 Documentation/input/index.rst
rename Documentation/input/{input-programming.txt => input-programming.rst} (69%)
rename Documentation/input/{input.txt => input.rst} (55%)
delete mode 100644 Documentation/input/interactive.fig
create mode 100644 Documentation/input/interactive.svg
rename Documentation/input/{joystick-api.txt => joystick-api.rst} (79%)
create mode 100644 Documentation/input/joystick-parport.rst
delete mode 100644 Documentation/input/joystick-parport.txt
rename Documentation/input/{joystick.txt => joystick.rst} (50%)
rename Documentation/input/{multi-touch-protocol.txt => multi-touch-protocol.rst} (68%)
rename Documentation/input/{notifier.txt => notifier.rst} (90%)
rename Documentation/input/{ntrig.txt => ntrig.rst} (75%)
rename Documentation/input/{rotary-encoder.txt => rotary-encoder.rst} (75%)
create mode 100644 Documentation/input/sentelic.rst
delete mode 100644 Documentation/input/sentelic.txt
delete mode 100644 Documentation/input/shape.fig
create mode 100644 Documentation/input/shape.svg
rename Documentation/input/{userio.txt => userio.rst} (56%)
rename Documentation/input/{walkera0701.txt => walkera0701.rst} (86%)
rename Documentation/input/{xpad.txt => xpad.rst} (81%)
rename Documentation/input/{yealink.txt => yealink.rst} (63%)
--
2.9.3
next reply other threads:[~2017-04-04 10:52 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-04-04 10:52 Mauro Carvalho Chehab [this message]
2017-04-04 10:52 ` [PATCH v2 01/33] docs: Documentation/input/input: convert it to ReST format Mauro Carvalho Chehab
[not found] ` <8e64d13bfc6952bc9370593ddc556a539f589654.1491302719.git.mchehab@s-opensource.com>
[not found] ` <781a89b410f25a2fb39d081d1ebd696317b6d2c2.1491302719.git.mchehab@s-opensource.com>
[not found] ` <6800b2c4e8f67b699c22533f7574d380b37cb6d6.1491302719.git.mchehab@s-opensource.com>
[not found] ` <9f6ae6ca543f4aa294afd000b7c8a8f49b2e8382.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 06/33] docs: input/bcm5974: " Mauro Carvalho Chehab
2017-04-04 10:52 ` [PATCH v2 07/33] docs: input/cd32: " Mauro Carvalho Chehab
[not found] ` <e67db9bffc4a93a93b8559ed85d6e77045a99157.1491302719.git.mchehab@s-opensource.com>
[not found] ` <9794ec8a2147f66e9e183f612fa7e834c9245dd9.1491302719.git.mchehab@s-opensource.com>
[not found] ` <3bb792c867ec11d1e5b998b2d44e99fbd654ff95.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 11/33] docs: input/event-codes: " Mauro Carvalho Chehab
2017-04-04 10:52 ` [PATCH v2 12/33] docs: input/ff: " Mauro Carvalho Chehab
[not found] ` <3efc02b3379dc908bfc0ade34185469295fee2bc.1491302719.git.mchehab@s-opensource.com>
[not found] ` <9b1b818d7cde485713aced6b077f0e276a24bddd.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 15/33] docs: input/gpio-tilt: " Mauro Carvalho Chehab
[not found] ` <8e0ef882aa235e4e6e758662dc434567266fb541.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 17/33] docs: input/input-programming: " Mauro Carvalho Chehab
[not found] ` <c4d96be24099f525b771369e2c0dd9bdfd376fa0.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 19/33] docs: input/joystick: " Mauro Carvalho Chehab
2017-04-04 10:52 ` [PATCH v2 20/33] docs: input/joystick-parport: " Mauro Carvalho Chehab
[not found] ` <e297fc785d72be336c2e4a85705c24eedb16cf7d.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 22/33] docs: input/notifier: " Mauro Carvalho Chehab
[not found] ` <c6f7140e3bdbfb30a338550b700d25667b764594.1491302719.git.mchehab@s-opensource.com>
[not found] ` <3552e3986d3848001b89449926d04f44930c681e.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 25/33] docs: input/sentelic: " Mauro Carvalho Chehab
[not found] ` <679c283194489e852074900b0133b5b6acd9395f.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 27/33] docs: input/walkera0701: " Mauro Carvalho Chehab
[not found] ` <ff44ad91600b12a8475e3e46a8a121dcbd3eedd9.1491302719.git.mchehab@s-opensource.com>
[not found] ` <55d263f13237495276213de295ae1c6d67f0588b.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 30/33] docs-rst: create a book with Linux Input documentation Mauro Carvalho Chehab
[not found] ` <a6e09069e3a232652651c2aac6d0906e728422e2.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52 ` [PATCH v2 32/33] docs: input/interactive: convert from xfig to svg Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 01/37] docs: Documentation/input/input: convert it to ReST format Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 02/37] docs: input/alps: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 03/37] docs: input/amijoy: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 04/37] docs: input/appletouch: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 05/37] docs: input/atarikbd: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 06/37] docs: input/bcm5974: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 07/37] docs: input/cd32: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 08/37] docs: input/cma3000_d0x: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 09/37] docs: input/cs461x: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 10/37] docs: input/elantech: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 11/37] docs: input/event-codes: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 12/37] docs: input/ff: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 13/37] docs: input/gamepad: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 14/37] docs: input/gameport-programming: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 15/37] docs: input/gpio-tilt: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 16/37] docs: input/iforce-protocol: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 17/37] docs: input/input-programming: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 18/37] docs: input/joystick-api: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 19/37] docs: input/joystick: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 20/37] docs: input/joystick-parport: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 21/37] docs: input/multi-touch-protocol: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 22/37] docs: input/notifier: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 23/37] docs: input/ntrig: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 24/37] docs: input/rotary-encoder: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 25/37] docs: input/sentelic: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 26/37] docs: input/userio: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 27/37] docs: input/walkera0701: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 28/37] docs: input/xpad: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 29/37] docs: input/yealink: " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 30/37] docs-rst: create a book with Linux Input documentation Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 31/37] docs: input/shape: convert it from xfig to svg Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 32/37] docs: input/interactive: convert " Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 33/37] docs: ff.rst: use svg files instead of xfig Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 34/37] input: add an EV_REL event for high-res vertical wheel Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 35/37] input: add a EV_SW event for ratchet switch Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 36/37] hid-logitech-hidpp: add support for high res wheel Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 37/37] hid-logitech-hidpp: add support for ratchet switch Mauro Carvalho Chehab
2017-04-05 12:03 ` [PATCH v2 35/37] input: add a EV_SW event " Peter Hutterer
2017-04-07 0:16 ` Mauro Carvalho Chehab
2017-04-07 0:53 ` Peter Hutterer
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=cover.1491302719.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=Henk.Vergonet@gmail.com \
--cc=ben@smart-cactus.org \
--cc=corbet@lwn.net \
--cc=dmitry.torokhov@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=martink@posteo.de \
--cc=peter.hutterer@who-t.net \
--cc=rydberg@bitmath.org \
--cc=usbb2k-api-dev@nongnu.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).