doc/user: move ignoring devices to separate page

This is way too hidden to the point where i couldn't find it for quite a
while despite knowing it exists. Move it to an entry under
troubleshooting.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

diff --git a/doc/user/device-configuration-via-udev.rst b/doc/user/device-configuration-via-udev.rst
index ee3345ca78fd1d3b0aca253128e5798473baa1c2..e6848b64453c4b9c10bda9e2b007a1e89c5ce192 100644 (file)
--- a/doc/user/device-configuration-via-udev.rst
+++ b/doc/user/device-configuration-via-udev.rst
@@ -108,42 +108,6 @@ for a device with the vendor/model ID of ``012a``/``034b``. ::
      ENV{ID_INPUT_TOUCHPAD}="", ENV{ID_INPUT_TABLET}="1"
 
 
-
-.. _ignoring_devices:
-
-------------------------------------------------------------------------------
-Ignoring specific devices
-------------------------------------------------------------------------------
-
-If a device has the **LIBINPUT_IGNORE_DEVICE** udev property set to any
-value but "0", that device is not initialized by libinput. For a context
-created with **libinput_udev_create_context()**, the device is silently ignored
-and never shows up. If the device is added with **libinput_path_add_device()**
-to a context created with **libinput_path_create_context()**, adding the device
-will fail and return NULL (see that function's documentation for more
-information).
-
-If the property value is exactly "0", then the property is considered unset
-and libinput initializes the device normally.
-
-This property should be used for devices that are correctly detected as
-input devices (see :ref:`udev_device_type`) but that should not be used by
-libinput. It is recommended that devices that should not be handled as input
-devices at all unset the **ID_INPUT** and related properties instead. The
-**LIBINPUT_IGNORE_DEVICE** property signals that only libinput should
-ignore this property but other parts of the stack (if any) should continue
-treating this device normally.
-
-Below is an example udev rule  to assign **LIBINPUT_IGNORE_DEVICE** to the
-device with the vendor/model ID of ``012a``/``034b``. ::
-
-  $ cat /etc/udev/rules.d/99-ignore-my-device.rules
-  ACTION=="add|change", KERNEL=="event[0-9]*", \
-     ENV{ID_VENDOR_ID}=="012a", \
-     ENV{ID_MODEL_ID}=="034b", \
-     ENV{LIBINPUT_IGNORE_DEVICE}="1"
-
-
 .. _model_specific_configuration:
 
 ------------------------------------------------------------------------------

diff --git a/doc/user/ignoring-devices.rst b/doc/user/ignoring-devices.rst
new file mode 100644 (file)
index 0000000..b6d27de
--- /dev/null
+++ b/doc/user/ignoring-devices.rst
@@ -0,0 +1,36 @@
+.. _ignoring_devices:
+
+==============================================================================
+Ignoring specific devices
+==============================================================================
+
+If a device has the **LIBINPUT_IGNORE_DEVICE** udev property set to any
+value but "0", that device is not initialized by libinput.
+For a context created with **libinput_udev_create_context()**, the device is
+silently ignored and never shows up. If the device is added with
+**libinput_path_add_device()** to a context created with
+**libinput_path_create_context()**, adding the device will fail and return NULL
+(see that function's documentation for more
+information).
+
+If the property value is exactly "0", then the property is considered unset
+and libinput initializes the device normally.
+
+This property should be used for devices that are correctly detected as
+input devices (see :ref:`udev_device_type`) but that should not be used by
+libinput. It is recommended that devices that should not be handled as input
+devices at all unset the **ID_INPUT** and related properties instead. The
+**LIBINPUT_IGNORE_DEVICE** property signals that only libinput should
+ignore this property but other parts of the stack (if any) should continue
+treating this device normally.
+
+Below is an example udev rule  to assign **LIBINPUT_IGNORE_DEVICE** to the
+device with the vendor/model ID of ``012a``/``034b``. ::
+
+  $ cat /etc/udev/rules.d/99-ignore-my-device.rules
+  ACTION=="add|change", KERNEL=="event[0-9]*", \
+     ENV{ID_VENDOR_ID}=="012a", \
+     ENV{ID_MODEL_ID}=="034b", \
+     ENV{LIBINPUT_IGNORE_DEVICE}="1"
+
+See :ref:`udev_config` for more details on libinput's udev properties.

diff --git a/doc/user/meson.build b/doc/user/meson.build
index 36c4fe3e253191989551c1e72b3510dccccd9705..86de69816f109744011235e1da05881609021f0d 100644 (file)
--- a/doc/user/meson.build
+++ b/doc/user/meson.build
@@ -146,6 +146,7 @@ src_rst = files(
        'faqs.rst',
        'gestures.rst',
        'incorrectly-enabled-hires.rst',
+       'ignoring-devices.rst',
        'middle-button-emulation.rst',
        'normalization-of-relative-motion.rst',
        'palm-detection.rst',

diff --git a/doc/user/troubleshooting.rst b/doc/user/troubleshooting.rst
index eaf18c551510e0f74f330875c837ac53492e9f62..1a70f93aa72f0bea47e9180d89464522405d4c2f 100644 (file)
--- a/doc/user/troubleshooting.rst
+++ b/doc/user/troubleshooting.rst
@@ -16,3 +16,4 @@ Troubleshooting
    tablet-debugging.rst
    incorrectly-enabled-hires.rst
    clickpad-with-right-button.rst
+   ignoring-devices.rst