doc/user: move the tablet capabilities debugging to a separate page
authorPeter Hutterer <peter.hutterer@who-t.net>
Sun, 19 Aug 2018 23:49:55 +0000 (09:49 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Mon, 20 Aug 2018 00:06:42 +0000 (10:06 +1000)
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/user/meson.build
doc/user/tablet-debugging.rst [new file with mode: 0644]
doc/user/tablet-support.rst
doc/user/troubleshooting.rst

index fb2461ddcdd97b4310fe8248520fdeed53ea4333..fce6ec1574656fe5b309ddc5a5efb672c0fa2cc7 100644 (file)
@@ -153,6 +153,7 @@ src_rst = files(
        'tapping.rst',
        'test-suite.rst',
        'timestamps.rst',
+       'tablet-debugging.rst',
        'tools.rst',
        'touchpad-jumping-cursors.rst',
        'touchpad-pressure.rst',
diff --git a/doc/user/tablet-debugging.rst b/doc/user/tablet-debugging.rst
new file mode 100644 (file)
index 0000000..2676650
--- /dev/null
@@ -0,0 +1,44 @@
+.. _tablet-debugging:
+
+==============================================================================
+Debugging tablet issues
+==============================================================================
+
+.. _tablet-capabilities:
+
+------------------------------------------------------------------------------
+Required tablet capabilities
+------------------------------------------------------------------------------
+
+To handle a tablet correctly, libinput requires a set of capabilities
+on the device. When these capabilities are missing, libinput ignores the
+device and prints an error to the log. This error messages reads
+
+::
+
+     missing tablet capabilities: xy pen btn-stylus resolution. Ignoring this device.
+
+or in older versions of libinput simply:
+
+::
+
+     libinput bug: device does not meet tablet criteria. Ignoring this device.
+
+
+When a tablet is rejected, it is usually possible to verify the issue with
+the ``libinput record`` tool.
+
+- **xy** indicates that the tablet is missing the ``ABS_X`` and/or ``ABS_Y``
+  axis. This indicates that the device is mislabelled and the udev tag
+  ``ID_INPUT_TABLET`` is applied to a device that is not a tablet.
+  A bug should be filed against `systemd <http://github.com/systemd/systemd>`__.
+- **pen** or **btn-stylus** indicates that the tablet does not have the
+  ``BTN_TOOL_PEN`` or ``BTN_STYLUS`` bit set. libinput requires either or both
+  of them to be present. This indicates a bug in the kernel driver
+  or the HID descriptors of the device.
+- **resolution** indicates that the device does not have a resolution set
+  for the x and y axes. This can be fixed with a hwdb entry, locate and read
+  the `60-evdev.hwdb
+  <https://github.com/systemd/systemd/tree/master/hwdb/60-evdev.hwdb>`__ file
+  on your machine and file a pull request with the fixes against
+  `systemd <https://github.com/systemd/systemd/>`__.
index 104ea4489e5c2ff7cf14daa239e3eb4c517b5cac..c9adb81408a41bb0f7661a6037ef68d7d7072d9c 100644 (file)
@@ -422,37 +422,3 @@ libinput uses the **libinput_device_group** to decide on touch arbitration
 and automatically discards touch events whenever a tool is in proximity.
 The exact behavior is device-dependent.
 
-.. _tablet-capabilities:
-
-------------------------------------------------------------------------------
-Required tablet capabilities
-------------------------------------------------------------------------------
-
-To handle a tablet correctly, libinput requires a set of capabilities
-on the device. When these capabilities are missing, libinput ignores the
-device and prints an error to the log. This error messages reads
-
-::
-
-     missing tablet capabilities: xy pen btn-stylus resolution. Ignoring this device.
-
-or in older versions of libinput simply:
-
-::
-
-     libinput bug: device does not meet tablet criteria. Ignoring this device.
-
-
-When a tablet is rejected, it is usually possible to check the issue with
-the ``evemu-descibe`` tool.
-
-- **xy** indicates that the tablet is missing the ``ABS_X`` and/or ``ABS_Y``
-  axis. This indicates that the device is mislabelled and the udev tag
-  ``ID_INPUT_TABLET`` is applied to a device that is not a tablet.
-- **pen** or **btn-stylus** indicates that the tablet does not have the
-  ``BTN_TOOL_PEN`` or ``BTN_STYLUS`` bit set. libinput requires either or both
-  of them to be present. This usually indicates a bug in the kernel driver
-  or the HID descriptors of the device.
-- **resolution** indicates that the device does not have a resolution set
-  for the x and y axes. This can be fixed with a hwdb entry, locate and read
-  the 60-evdev.hwdb file on your machine to address this.
index da7c9f42fa3f4ae01ba7327169977e2f3138575b..a66f96c210c6ae1e39f17bf517119bcb1e5b0117 100644 (file)
@@ -13,3 +13,4 @@ Troubleshooting
    touchpad-jitter.rst
    touchpad-pressure-debugging.rst
    trackpoint-configuration.rst
+   tablet-debugging.rst