diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-04-04 17:51:04 -0700 |
---|---|---|
committer | Dmitry Torokhov <dmitry.torokhov@gmail.com> | 2017-04-05 15:45:07 -0700 |
commit | e2ba573120feadfb365467f0cdae2918926efabc (patch) | |
tree | 0274ef579fcafc4646d0c82eeb4ae826ff61cfbd | |
parent | 1ad1473f65da8e61120e8f1b68bc92f2b71ba879 (diff) |
Input: create a book with Linux Input documentation
Now that all files under Documentation/input follows the ReST markup
language, rename them to *.rst and create a book for the Linux Input
subsystem.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
-rw-r--r-- | Documentation/conf.py | 2 | ||||
-rw-r--r-- | Documentation/input/alps.rst (renamed from Documentation/input/alps.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/amijoy.rst (renamed from Documentation/input/amijoy.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/appletouch.rst (renamed from Documentation/input/appletouch.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/atarikbd.rst (renamed from Documentation/input/atarikbd.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/bcm5974.rst (renamed from Documentation/input/bcm5974.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/cd32.rst (renamed from Documentation/input/cd32.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/cma3000_d0x.rst (renamed from Documentation/input/cma3000_d0x.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/conf.py | 10 | ||||
-rw-r--r-- | Documentation/input/cs461x.rst (renamed from Documentation/input/cs461x.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/edt-ft5x06.rst (renamed from Documentation/input/edt-ft5x06.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/elantech.rst (renamed from Documentation/input/elantech.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/event-codes.rst (renamed from Documentation/input/event-codes.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/ff.rst (renamed from Documentation/input/ff.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/gamepad.rst (renamed from Documentation/input/gamepad.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/gameport-programming.rst (renamed from Documentation/input/gameport-programming.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/gpio-tilt.rst (renamed from Documentation/input/gpio-tilt.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/iforce-protocol.rst (renamed from Documentation/input/iforce-protocol.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/index.rst | 77 | ||||
-rw-r--r-- | Documentation/input/input-programming.rst (renamed from Documentation/input/input-programming.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/input.rst (renamed from Documentation/input/input.txt) | 20 | ||||
-rw-r--r-- | Documentation/input/joystick-api.rst (renamed from Documentation/input/joystick-api.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/joystick-parport.rst (renamed from Documentation/input/joystick-parport.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/joystick.rst (renamed from Documentation/input/joystick.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/multi-touch-protocol.rst (renamed from Documentation/input/multi-touch-protocol.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/notifier.rst (renamed from Documentation/input/notifier.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/ntrig.rst (renamed from Documentation/input/ntrig.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/rotary-encoder.rst (renamed from Documentation/input/rotary-encoder.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/sentelic.rst (renamed from Documentation/input/sentelic.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/userio.rst (renamed from Documentation/input/userio.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/walkera0701.rst (renamed from Documentation/input/walkera0701.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/xpad.rst (renamed from Documentation/input/xpad.txt) | 0 | ||||
-rw-r--r-- | Documentation/input/yealink.rst (renamed from Documentation/input/yealink.txt) | 0 | ||||
-rw-r--r-- | MAINTAINERS | 4 |
34 files changed, 91 insertions, 22 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index 7fadb3b83293..fef209edb4d7 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -348,6 +348,8 @@ latex_documents = [ 'The kernel development community', 'manual'), ('driver-api/index', 'driver-api.tex', 'The kernel driver API manual', 'The kernel development community', 'manual'), + ('input/index', 'linux-input.tex', 'The Linux input driver subsystem', + 'The kernel development community', 'manual'), ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation', 'The kernel development community', 'manual'), ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation', diff --git a/Documentation/input/alps.txt b/Documentation/input/alps.rst index 76a71a146e50..76a71a146e50 100644 --- a/Documentation/input/alps.txt +++ b/Documentation/input/alps.rst diff --git a/Documentation/input/amijoy.txt b/Documentation/input/amijoy.rst index 8df7b11cd98d..8df7b11cd98d 100644 --- a/Documentation/input/amijoy.txt +++ b/Documentation/input/amijoy.rst diff --git a/Documentation/input/appletouch.txt b/Documentation/input/appletouch.rst index c94470e66533..c94470e66533 100644 --- a/Documentation/input/appletouch.txt +++ b/Documentation/input/appletouch.rst diff --git a/Documentation/input/atarikbd.txt b/Documentation/input/atarikbd.rst index 745e7a1ff122..745e7a1ff122 100644 --- a/Documentation/input/atarikbd.txt +++ b/Documentation/input/atarikbd.rst diff --git a/Documentation/input/bcm5974.txt b/Documentation/input/bcm5974.rst index 4aca199b0aa6..4aca199b0aa6 100644 --- a/Documentation/input/bcm5974.txt +++ b/Documentation/input/bcm5974.rst diff --git a/Documentation/input/cd32.txt b/Documentation/input/cd32.rst index 935028b957d9..935028b957d9 100644 --- a/Documentation/input/cd32.txt +++ b/Documentation/input/cd32.rst diff --git a/Documentation/input/cma3000_d0x.txt b/Documentation/input/cma3000_d0x.rst index 6f40c17c1aca..6f40c17c1aca 100644 --- a/Documentation/input/cma3000_d0x.txt +++ b/Documentation/input/cma3000_d0x.rst diff --git a/Documentation/input/conf.py b/Documentation/input/conf.py new file mode 100644 index 000000000000..d2352fdc92ed --- /dev/null +++ b/Documentation/input/conf.py @@ -0,0 +1,10 @@ +# -*- coding: utf-8; mode: python -*- + +project = "The Linux input driver subsystem" + +tags.add("subproject") + +latex_documents = [ + ('index', 'linux-input.tex', project, + 'The kernel development community', 'manual'), +] diff --git a/Documentation/input/cs461x.txt b/Documentation/input/cs461x.rst index 1450436dcc9e..1450436dcc9e 100644 --- a/Documentation/input/cs461x.txt +++ b/Documentation/input/cs461x.rst diff --git a/Documentation/input/edt-ft5x06.txt b/Documentation/input/edt-ft5x06.rst index 2032f0b7a8fa..2032f0b7a8fa 100644 --- a/Documentation/input/edt-ft5x06.txt +++ b/Documentation/input/edt-ft5x06.rst diff --git a/Documentation/input/elantech.txt b/Documentation/input/elantech.rst index c3374a7ce7af..c3374a7ce7af 100644 --- a/Documentation/input/elantech.txt +++ b/Documentation/input/elantech.rst diff --git a/Documentation/input/event-codes.txt b/Documentation/input/event-codes.rst index 92db50954169..92db50954169 100644 --- a/Documentation/input/event-codes.txt +++ b/Documentation/input/event-codes.rst diff --git a/Documentation/input/ff.txt b/Documentation/input/ff.rst index 6d6688a63dd8..6d6688a63dd8 100644 --- a/Documentation/input/ff.txt +++ b/Documentation/input/ff.rst diff --git a/Documentation/input/gamepad.txt b/Documentation/input/gamepad.rst index 1bc4555c0ccb..1bc4555c0ccb 100644 --- a/Documentation/input/gamepad.txt +++ b/Documentation/input/gamepad.rst diff --git a/Documentation/input/gameport-programming.txt b/Documentation/input/gameport-programming.rst index c96911df1c54..c96911df1c54 100644 --- a/Documentation/input/gameport-programming.txt +++ b/Documentation/input/gameport-programming.rst diff --git a/Documentation/input/gpio-tilt.txt b/Documentation/input/gpio-tilt.rst index 23de9eff6a34..23de9eff6a34 100644 --- a/Documentation/input/gpio-tilt.txt +++ b/Documentation/input/gpio-tilt.rst diff --git a/Documentation/input/iforce-protocol.txt b/Documentation/input/iforce-protocol.rst index 8634beac3fdb..8634beac3fdb 100644 --- a/Documentation/input/iforce-protocol.txt +++ b/Documentation/input/iforce-protocol.rst diff --git a/Documentation/input/index.rst b/Documentation/input/index.rst new file mode 100644 index 000000000000..153f0d476c3e --- /dev/null +++ b/Documentation/input/index.rst @@ -0,0 +1,77 @@ +============================= +The Linux Input Documentation +============================= + +Disclaimer +========== + +This program is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2 of the License, or (at your option) +any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., 59 +Temple Place, Suite 330, Boston, MA 02111-1307 USA + +For your convenience, the GNU General Public License version 2 is included +in the package: See the file COPYING. + + +Core API +======== + +.. toctree:: + :maxdepth: 2 + :numbered: + + input + input-programming + event-codes + joystick + joystick-api + multi-touch-protocol + gamepad + gameport-programming + ff + notifier + userio + +Input drivers +============= + +.. toctree:: + :maxdepth: 2 + :numbered: + + alps + amijoy + appletouch + atarikbd + bcm5974 + cd32 + cma3000_d0x + cs461x + edt-ft5x06 + elantech + iforce-protocol + joystick-parport + gpio-tilt + ntrig + rotary-encoder + sentelic + walkera0701 + xpad + yealink + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` diff --git a/Documentation/input/input-programming.txt b/Documentation/input/input-programming.rst index 4d3b22222e93..4d3b22222e93 100644 --- a/Documentation/input/input-programming.txt +++ b/Documentation/input/input-programming.rst diff --git a/Documentation/input/input.txt b/Documentation/input/input.rst index fda995e0ceb0..ac7669ad3e76 100644 --- a/Documentation/input/input.txt +++ b/Documentation/input/input.rst @@ -6,30 +6,10 @@ Linux Input drivers :Copyright: |copy| 1999-2001 Vojtech Pavlik <vojtech@ucw.cz> - Sponsored by SuSE -Disclaimer -========== - -This program is free software; you can redistribute it and/or modify it -under the terms of the GNU General Public License as published by the Free -Software Foundation; either version 2 of the License, or (at your option) -any later version. - -This program is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY -or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for -more details. - -You should have received a copy of the GNU General Public License along -with this program; if not, write to the Free Software Foundation, Inc., 59 -Temple Place, Suite 330, Boston, MA 02111-1307 USA - Should you need to contact me, the author, you can do so either by e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic -For your convenience, the GNU General Public License version 2 is included -in the package: See the file COPYING. - Introduction ============ diff --git a/Documentation/input/joystick-api.txt b/Documentation/input/joystick-api.rst index 9b9d26833086..9b9d26833086 100644 --- a/Documentation/input/joystick-api.txt +++ b/Documentation/input/joystick-api.rst diff --git a/Documentation/input/joystick-parport.txt b/Documentation/input/joystick-parport.rst index 0aa0fb17bf48..0aa0fb17bf48 100644 --- a/Documentation/input/joystick-parport.txt +++ b/Documentation/input/joystick-parport.rst diff --git a/Documentation/input/joystick.txt b/Documentation/input/joystick.rst index 202f5a090675..202f5a090675 100644 --- a/Documentation/input/joystick.txt +++ b/Documentation/input/joystick.rst diff --git a/Documentation/input/multi-touch-protocol.txt b/Documentation/input/multi-touch-protocol.rst index 81775d7c1997..81775d7c1997 100644 --- a/Documentation/input/multi-touch-protocol.txt +++ b/Documentation/input/multi-touch-protocol.rst diff --git a/Documentation/input/notifier.txt b/Documentation/input/notifier.rst index 161350cb865e..161350cb865e 100644 --- a/Documentation/input/notifier.txt +++ b/Documentation/input/notifier.rst diff --git a/Documentation/input/ntrig.txt b/Documentation/input/ntrig.rst index a6b22ce6c61c..a6b22ce6c61c 100644 --- a/Documentation/input/ntrig.txt +++ b/Documentation/input/ntrig.rst diff --git a/Documentation/input/rotary-encoder.txt b/Documentation/input/rotary-encoder.rst index 4695bea67f9b..4695bea67f9b 100644 --- a/Documentation/input/rotary-encoder.txt +++ b/Documentation/input/rotary-encoder.rst diff --git a/Documentation/input/sentelic.txt b/Documentation/input/sentelic.rst index d1a476f973b1..d1a476f973b1 100644 --- a/Documentation/input/sentelic.txt +++ b/Documentation/input/sentelic.rst diff --git a/Documentation/input/userio.txt b/Documentation/input/userio.rst index f780c77931fe..f780c77931fe 100644 --- a/Documentation/input/userio.txt +++ b/Documentation/input/userio.rst diff --git a/Documentation/input/walkera0701.txt b/Documentation/input/walkera0701.rst index 2adda99ca717..2adda99ca717 100644 --- a/Documentation/input/walkera0701.txt +++ b/Documentation/input/walkera0701.rst diff --git a/Documentation/input/xpad.txt b/Documentation/input/xpad.rst index 0bae002cf17a..0bae002cf17a 100644 --- a/Documentation/input/xpad.txt +++ b/Documentation/input/xpad.rst diff --git a/Documentation/input/yealink.txt b/Documentation/input/yealink.rst index b231d8baf4bb..b231d8baf4bb 100644 --- a/Documentation/input/yealink.txt +++ b/Documentation/input/yealink.rst diff --git a/MAINTAINERS b/MAINTAINERS index 1b0a87ffffab..092de1d6f8f9 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -6488,7 +6488,7 @@ INPUT MULTITOUCH (MT) PROTOCOL M: Henrik Rydberg <rydberg@bitmath.org> L: linux-input@vger.kernel.org S: Odd fixes -F: Documentation/input/multi-touch-protocol.txt +F: Documentation/input/multi-touch-protocol.rst F: drivers/input/input-mt.c K: \b(ABS|SYN)_MT_ @@ -13812,7 +13812,7 @@ YEALINK PHONE DRIVER M: Henk Vergonet <Henk.Vergonet@gmail.com> L: usbb2k-api-dev@nongnu.org S: Maintained -F: Documentation/input/yealink.txt +F: Documentation/input/yealink.rst F: drivers/input/misc/yealink.* Z8530 DRIVER FOR AX.25 |