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>
mariux64 · Apr 5, 2017 · e2ba573 · e2ba573
1 parent 1ad1473
commit e2ba573
Show file tree

Hide file tree

Showing 34 changed files with 91 additions and 22 deletions.
diff --git a/Documentation/conf.py b/Documentation/conf.py
@@ -348,6 +348,8 @@
      '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 → Documentation/input/alps.rst b/Documentation/input/alps.txt → Documentation/input/alps.rst
diff --git a/Documentation/input/amijoy.txt → Documentation/input/amijoy.rst b/Documentation/input/amijoy.txt → Documentation/input/amijoy.rst
diff --git a/Documentation/input/appletouch.txt → Documentation/input/appletouch.rst b/Documentation/input/appletouch.txt → Documentation/input/appletouch.rst
diff --git a/Documentation/input/atarikbd.txt → Documentation/input/atarikbd.rst b/Documentation/input/atarikbd.txt → Documentation/input/atarikbd.rst
diff --git a/Documentation/input/bcm5974.txt → Documentation/input/bcm5974.rst b/Documentation/input/bcm5974.txt → Documentation/input/bcm5974.rst
diff --git a/Documentation/input/cd32.txt → Documentation/input/cd32.rst b/Documentation/input/cd32.txt → Documentation/input/cd32.rst
diff --git a/Documentation/input/cma3000_d0x.txt → Documentation/input/cma3000_d0x.rst b/Documentation/input/cma3000_d0x.txt → Documentation/input/cma3000_d0x.rst
diff --git a/Documentation/input/conf.py 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 → Documentation/input/cs461x.rst b/Documentation/input/cs461x.txt → Documentation/input/cs461x.rst
diff --git a/Documentation/input/edt-ft5x06.txt → Documentation/input/edt-ft5x06.rst b/Documentation/input/edt-ft5x06.txt → Documentation/input/edt-ft5x06.rst
diff --git a/Documentation/input/elantech.txt → Documentation/input/elantech.rst b/Documentation/input/elantech.txt → Documentation/input/elantech.rst
diff --git a/Documentation/input/event-codes.txt → Documentation/input/event-codes.rst b/Documentation/input/event-codes.txt → Documentation/input/event-codes.rst
diff --git a/Documentation/input/ff.txt → Documentation/input/ff.rst b/Documentation/input/ff.txt → Documentation/input/ff.rst
diff --git a/Documentation/input/gamepad.txt → Documentation/input/gamepad.rst b/Documentation/input/gamepad.txt → Documentation/input/gamepad.rst
diff --git a/Documentation/input/gameport-programming.txt → Documentation/input/gameport-programming.rst b/Documentation/input/gameport-programming.txt → Documentation/input/gameport-programming.rst
diff --git a/Documentation/input/gpio-tilt.txt → Documentation/input/gpio-tilt.rst b/Documentation/input/gpio-tilt.txt → Documentation/input/gpio-tilt.rst
diff --git a/Documentation/input/iforce-protocol.txt → Documentation/input/iforce-protocol.rst b/Documentation/input/iforce-protocol.txt → Documentation/input/iforce-protocol.rst
diff --git a/Documentation/input/index.rst 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 → Documentation/input/input-programming.rst b/Documentation/input/input-programming.txt → Documentation/input/input-programming.rst
diff --git a/Documentation/input/input.txt → Documentation/input/input.rst b/Documentation/input/input.txt → 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 → Documentation/input/joystick-api.rst b/Documentation/input/joystick-api.txt → Documentation/input/joystick-api.rst
diff --git a/Documentation/input/joystick-parport.txt → Documentation/input/joystick-parport.rst b/Documentation/input/joystick-parport.txt → Documentation/input/joystick-parport.rst
diff --git a/Documentation/input/joystick.txt → Documentation/input/joystick.rst b/Documentation/input/joystick.txt → Documentation/input/joystick.rst
diff --git a/Documentation/input/multi-touch-protocol.txt → Documentation/input/multi-touch-protocol.rst b/Documentation/input/multi-touch-protocol.txt → Documentation/input/multi-touch-protocol.rst
diff --git a/Documentation/input/notifier.txt → Documentation/input/notifier.rst b/Documentation/input/notifier.txt → Documentation/input/notifier.rst
diff --git a/Documentation/input/ntrig.txt → Documentation/input/ntrig.rst b/Documentation/input/ntrig.txt → Documentation/input/ntrig.rst
diff --git a/Documentation/input/rotary-encoder.txt → Documentation/input/rotary-encoder.rst b/Documentation/input/rotary-encoder.txt → Documentation/input/rotary-encoder.rst
diff --git a/Documentation/input/sentelic.txt → Documentation/input/sentelic.rst b/Documentation/input/sentelic.txt → Documentation/input/sentelic.rst
diff --git a/Documentation/input/userio.txt → Documentation/input/userio.rst b/Documentation/input/userio.txt → Documentation/input/userio.rst
diff --git a/Documentation/input/walkera0701.txt → Documentation/input/walkera0701.rst b/Documentation/input/walkera0701.txt → Documentation/input/walkera0701.rst
diff --git a/Documentation/input/xpad.txt → Documentation/input/xpad.rst b/Documentation/input/xpad.txt → Documentation/input/xpad.rst
diff --git a/Documentation/input/yealink.txt → Documentation/input/yealink.rst b/Documentation/input/yealink.txt → Documentation/input/yealink.rst
diff --git 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