From e2ba573120feadfb365467f0cdae2918926efabc Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 4 Apr 2017 17:51:04 -0700 Subject: [PATCH] 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 Signed-off-by: Dmitry Torokhov --- Documentation/conf.py | 2 + Documentation/input/{alps.txt => alps.rst} | 0 .../input/{amijoy.txt => amijoy.rst} | 0 .../input/{appletouch.txt => appletouch.rst} | 0 .../input/{atarikbd.txt => atarikbd.rst} | 0 .../input/{bcm5974.txt => bcm5974.rst} | 0 Documentation/input/{cd32.txt => cd32.rst} | 0 .../{cma3000_d0x.txt => cma3000_d0x.rst} | 0 Documentation/input/conf.py | 10 +++ .../input/{cs461x.txt => cs461x.rst} | 0 .../input/{edt-ft5x06.txt => edt-ft5x06.rst} | 0 .../input/{elantech.txt => elantech.rst} | 0 .../{event-codes.txt => event-codes.rst} | 0 Documentation/input/{ff.txt => ff.rst} | 0 .../input/{gamepad.txt => gamepad.rst} | 0 ...ogramming.txt => gameport-programming.rst} | 0 .../input/{gpio-tilt.txt => gpio-tilt.rst} | 0 ...force-protocol.txt => iforce-protocol.rst} | 0 Documentation/input/index.rst | 77 +++++++++++++++++++ ...-programming.txt => input-programming.rst} | 0 Documentation/input/{input.txt => input.rst} | 20 ----- .../{joystick-api.txt => joystick-api.rst} | 0 ...stick-parport.txt => joystick-parport.rst} | 0 .../input/{joystick.txt => joystick.rst} | 0 ...-protocol.txt => multi-touch-protocol.rst} | 0 .../input/{notifier.txt => notifier.rst} | 0 Documentation/input/{ntrig.txt => ntrig.rst} | 0 ...{rotary-encoder.txt => rotary-encoder.rst} | 0 .../input/{sentelic.txt => sentelic.rst} | 0 .../input/{userio.txt => userio.rst} | 0 .../{walkera0701.txt => walkera0701.rst} | 0 Documentation/input/{xpad.txt => xpad.rst} | 0 .../input/{yealink.txt => yealink.rst} | 0 MAINTAINERS | 4 +- 34 files changed, 91 insertions(+), 22 deletions(-) rename Documentation/input/{alps.txt => alps.rst} (100%) rename Documentation/input/{amijoy.txt => amijoy.rst} (100%) rename Documentation/input/{appletouch.txt => appletouch.rst} (100%) rename Documentation/input/{atarikbd.txt => atarikbd.rst} (100%) rename Documentation/input/{bcm5974.txt => bcm5974.rst} (100%) rename Documentation/input/{cd32.txt => cd32.rst} (100%) rename Documentation/input/{cma3000_d0x.txt => cma3000_d0x.rst} (100%) create mode 100644 Documentation/input/conf.py rename Documentation/input/{cs461x.txt => cs461x.rst} (100%) rename Documentation/input/{edt-ft5x06.txt => edt-ft5x06.rst} (100%) rename Documentation/input/{elantech.txt => elantech.rst} (100%) rename Documentation/input/{event-codes.txt => event-codes.rst} (100%) rename Documentation/input/{ff.txt => ff.rst} (100%) rename Documentation/input/{gamepad.txt => gamepad.rst} (100%) rename Documentation/input/{gameport-programming.txt => gameport-programming.rst} (100%) rename Documentation/input/{gpio-tilt.txt => gpio-tilt.rst} (100%) rename Documentation/input/{iforce-protocol.txt => iforce-protocol.rst} (100%) create mode 100644 Documentation/input/index.rst rename Documentation/input/{input-programming.txt => input-programming.rst} (100%) rename Documentation/input/{input.txt => input.rst} (92%) rename Documentation/input/{joystick-api.txt => joystick-api.rst} (100%) rename Documentation/input/{joystick-parport.txt => joystick-parport.rst} (100%) rename Documentation/input/{joystick.txt => joystick.rst} (100%) rename Documentation/input/{multi-touch-protocol.txt => multi-touch-protocol.rst} (100%) rename Documentation/input/{notifier.txt => notifier.rst} (100%) rename Documentation/input/{ntrig.txt => ntrig.rst} (100%) rename Documentation/input/{rotary-encoder.txt => rotary-encoder.rst} (100%) rename Documentation/input/{sentelic.txt => sentelic.rst} (100%) rename Documentation/input/{userio.txt => userio.rst} (100%) rename Documentation/input/{walkera0701.txt => walkera0701.rst} (100%) rename Documentation/input/{xpad.txt => xpad.rst} (100%) rename Documentation/input/{yealink.txt => yealink.rst} (100%) 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 similarity index 100% rename from Documentation/input/alps.txt rename to Documentation/input/alps.rst diff --git a/Documentation/input/amijoy.txt b/Documentation/input/amijoy.rst similarity index 100% rename from Documentation/input/amijoy.txt rename to Documentation/input/amijoy.rst diff --git a/Documentation/input/appletouch.txt b/Documentation/input/appletouch.rst similarity index 100% rename from Documentation/input/appletouch.txt rename to Documentation/input/appletouch.rst diff --git a/Documentation/input/atarikbd.txt b/Documentation/input/atarikbd.rst similarity index 100% rename from Documentation/input/atarikbd.txt rename to Documentation/input/atarikbd.rst diff --git a/Documentation/input/bcm5974.txt b/Documentation/input/bcm5974.rst similarity index 100% rename from Documentation/input/bcm5974.txt rename to Documentation/input/bcm5974.rst diff --git a/Documentation/input/cd32.txt b/Documentation/input/cd32.rst similarity index 100% rename from Documentation/input/cd32.txt rename to Documentation/input/cd32.rst diff --git a/Documentation/input/cma3000_d0x.txt b/Documentation/input/cma3000_d0x.rst similarity index 100% rename from Documentation/input/cma3000_d0x.txt rename to 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 similarity index 100% rename from Documentation/input/cs461x.txt rename to Documentation/input/cs461x.rst diff --git a/Documentation/input/edt-ft5x06.txt b/Documentation/input/edt-ft5x06.rst similarity index 100% rename from Documentation/input/edt-ft5x06.txt rename to Documentation/input/edt-ft5x06.rst diff --git a/Documentation/input/elantech.txt b/Documentation/input/elantech.rst similarity index 100% rename from Documentation/input/elantech.txt rename to Documentation/input/elantech.rst diff --git a/Documentation/input/event-codes.txt b/Documentation/input/event-codes.rst similarity index 100% rename from Documentation/input/event-codes.txt rename to Documentation/input/event-codes.rst diff --git a/Documentation/input/ff.txt b/Documentation/input/ff.rst similarity index 100% rename from Documentation/input/ff.txt rename to Documentation/input/ff.rst diff --git a/Documentation/input/gamepad.txt b/Documentation/input/gamepad.rst similarity index 100% rename from Documentation/input/gamepad.txt rename to Documentation/input/gamepad.rst diff --git a/Documentation/input/gameport-programming.txt b/Documentation/input/gameport-programming.rst similarity index 100% rename from Documentation/input/gameport-programming.txt rename to Documentation/input/gameport-programming.rst diff --git a/Documentation/input/gpio-tilt.txt b/Documentation/input/gpio-tilt.rst similarity index 100% rename from Documentation/input/gpio-tilt.txt rename to Documentation/input/gpio-tilt.rst diff --git a/Documentation/input/iforce-protocol.txt b/Documentation/input/iforce-protocol.rst similarity index 100% rename from Documentation/input/iforce-protocol.txt rename to 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 similarity index 100% rename from Documentation/input/input-programming.txt rename to Documentation/input/input-programming.rst diff --git a/Documentation/input/input.txt b/Documentation/input/input.rst similarity index 92% rename from Documentation/input/input.txt rename to 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 - 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 , 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 similarity index 100% rename from Documentation/input/joystick-api.txt rename to Documentation/input/joystick-api.rst diff --git a/Documentation/input/joystick-parport.txt b/Documentation/input/joystick-parport.rst similarity index 100% rename from Documentation/input/joystick-parport.txt rename to Documentation/input/joystick-parport.rst diff --git a/Documentation/input/joystick.txt b/Documentation/input/joystick.rst similarity index 100% rename from Documentation/input/joystick.txt rename to Documentation/input/joystick.rst diff --git a/Documentation/input/multi-touch-protocol.txt b/Documentation/input/multi-touch-protocol.rst similarity index 100% rename from Documentation/input/multi-touch-protocol.txt rename to Documentation/input/multi-touch-protocol.rst diff --git a/Documentation/input/notifier.txt b/Documentation/input/notifier.rst similarity index 100% rename from Documentation/input/notifier.txt rename to Documentation/input/notifier.rst diff --git a/Documentation/input/ntrig.txt b/Documentation/input/ntrig.rst similarity index 100% rename from Documentation/input/ntrig.txt rename to Documentation/input/ntrig.rst diff --git a/Documentation/input/rotary-encoder.txt b/Documentation/input/rotary-encoder.rst similarity index 100% rename from Documentation/input/rotary-encoder.txt rename to Documentation/input/rotary-encoder.rst diff --git a/Documentation/input/sentelic.txt b/Documentation/input/sentelic.rst similarity index 100% rename from Documentation/input/sentelic.txt rename to Documentation/input/sentelic.rst diff --git a/Documentation/input/userio.txt b/Documentation/input/userio.rst similarity index 100% rename from Documentation/input/userio.txt rename to Documentation/input/userio.rst diff --git a/Documentation/input/walkera0701.txt b/Documentation/input/walkera0701.rst similarity index 100% rename from Documentation/input/walkera0701.txt rename to Documentation/input/walkera0701.rst diff --git a/Documentation/input/xpad.txt b/Documentation/input/xpad.rst similarity index 100% rename from Documentation/input/xpad.txt rename to Documentation/input/xpad.rst diff --git a/Documentation/input/yealink.txt b/Documentation/input/yealink.rst similarity index 100% rename from Documentation/input/yealink.txt rename to 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 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 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