From Fedora Project Wiki
(Initial draft)
No edit summary
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== General overview ==
For Fedora 13 (with xorg-x11-server-1.7.99.901-1) we disabled HAL configuration, so a fair bunch of configuration problems may come from that. The fdi files are now ignored, so the configurations need to be moved. We recommend that they be put as InputClass sections into the xorg.conf ('''careful when recommending to delete the xorg.conf for other bugs'''). This needs to be done manually, there's no automatic conversion tool.
Most evdev bugs aren’t actually evdev bugs. they tend to get caught before the releases. They’re either configuration issues (HAL, usually) or server bugs. especially when it comes to keyboard layouts etc., it’s nearly always server.
Most evdev bugs aren’t actually evdev bugs. they tend to get caught before the releases. They’re either configuration issues (HAL, usually) or server bugs. especially when it comes to keyboard layouts etc., it’s nearly always server.


Also, there are almost no <code>xorg-x11-drv-{mouse,keyboard}</code> bugs. User has to have <code>AutoAddDevices "off"</code>, or <code>"AllowEmptyInput" "off"</code> in the config file, so nobody without <code>xorg.conf</code> will use them.
Also, there are almost no <code>xorg-x11-drv-{mouse,keyboard}</code> bugs. User has to have <code>AutoAddDevices "off"</code>, or <code>"AllowEmptyInput" "off"</code> in the config file, so nobody without <code>xorg.conf</code> will use these drivers.


Real evdev bugs are usually when over time something degenerates, when the pointer jumps after pressing a button, things like that, or when the server says “don’t know how to use device” (in <code>Xorg.*.log</code>).
Real evdev bugs are usually when over time something degenerates, when the pointer jumps after pressing a button, things like that, or when the server says “don’t know how to use device” (in <code>Xorg.*.log</code>). In some cases, hardware is partially broken (usually a kernel issue). For those, usually bugs with mice and touchpads, ask for the evtest output of the device. If it's a bug that crashes the server, ask for the evtest-capture output on this device to reproduce.


Therefore most input device bugs are in the <code>xorg-x11-server</code> component, assigned to peter.
Therefore most input device bugs are in the <code>xorg-x11-server</code> component, assigned to peter.


== How to spread bugs between evdev and -mouse or -keyboard ==
== Log files ==
What log files are needed for bug triaging:
* /var/log/Xorg.0.log (or the Xorg.0.log.old after a crash, it contains the backtrace) is almost *always* needed. Please attach it as a whole, uncompressed. Note that depending on what $DISPLAY the server starts up, the numbers may be different or change after a restart (/var/log/Xorg.1.log, etc.). If you are not sure which one is the right one, check the timestamps on the file.
* xorg.conf if there is one
* ''Fedora 13 or later'': custom xorg.conf.d snippets if there are ones
* ''Fedora 12 or earlier'': output from lshal
* For keyboard layout issues: the output of "xkbcomp -xkb $DISPLAY -"
* For any device issues: evtest against the device file
* For any crashers or misbehavings after a certain series of (hardware) actions: evtest-capture against the device file


# is the device listed in <code>/proc/bus/input/devices</code>? no? -> kernel
== Keyboard layouts ==
# is the device listed in <code>lshal</code>? no? -> kernel
* Some modifier keys stop working, some keys don't repeat, etc. => '''xorg-x11-server'''. This must have a simple, seproducible test case, it's near-impossible to debug otherwise. Things like "do something for 20 minutes and then it stops working" isn't enough.
# is the devices listed with an <code>input.x11_driver</code> in <code>lshal</code>? no? -> hal configuration issue
* A keyboard layout works, but one or two keys provide the wrong symbols => '''xkeyboard-config''', should usually be upstreamed, Peter hands the decisions on layout changes to the upstream maintainer.
# any <code>input.x11_options</code> by the user? no? - hal configuration issue. These are hard because they’re usually typos that are hard to spot, but you can probably punt the user to the input device configuration wiki page and let them sort it out themselves.
* The user-selected layout does not apply => '''configuration issue, gnome-settings-daemon, gdm or xorg-x11-server.'''
# if the Xorg.log lists the device when it appears and says “don’t know how to use device” that means the device is not detected by <code>evdev</code>. It shouldn’t happen with <code>>= F11</code> or rawhide, can still happen with <code>F10</code>. If it happens with <code>> F11</code>, its a bug that needs to be fixed upstream (and in that case I always need the output from http://people.freedesktop.org/~whot/evtest.c)
** Does the layout from /etc/sysconfig/keyboard show up in the Xorg.log file (only for keyboard devices, devices like the Power Button or Video Bus stay on 'us')? no? => '''system-setup-keyboard'''
** Do user-configured options (in custom .fdi files) show up in the Xorg.log file? no? => hal configuration needs porting to xorg.conf format.
** Do user-configured options (in xorg.conf/xorg.conf.d) show up in the Xorg.log file? no? => '''xorg-x11-server'''
** Does the layout work in a plain X session (yum install xterm && sudo init 3 && xinit --)? no? => '''xorg-x11-server'''
** Does the layout work in a plain X session but stops working after login? => '''gnome-settings-daemon''' or possibly '''gdm'''
* Arrow keys broken (up == printscreen): this is caused by an xfree86 (or "base") ruleset for an evdev device. The cause of this is almost always a stray AllowEmptyInput "off" in the config (which is nearly always a wrong configuration). Removing the option fixes it.


I use output of <code>evtest</code> to write software test devices to simulate the hardware. the repository for that is at [git://people.freedesktop.org/~whot/testdevices.git git://people.freedesktop.org/~whot/testdevices.git], if the user can program, it’s quite simple to add new devices
== How to spread bugs between evdev, -mouse or -keyboard and kernel ==


If the device doesn’t send events or doesn’t behave properly, always check the evtest output too. if that one is busted, it’s a kernel or hardware issue.
# is the device listed in <code>/proc/bus/input/devices</code>? no? -> '''kernel'''
# does the device match any InputClass sections in /etc/xorg.conf.d/? no? -> '''configuration issue'''
# are there any user-configured options in the xorg.conf or /etc/xorg.conf.d but they're not merged? -> '''configuration issue''' or '''xorg-x11-server'''
# if the Xorg.log lists the device when it appears and says “don’t know how to use device” that means the device is not detected by '''evdev'''. It shouldn’t happen with <code>>= F11</code> or rawhide, can still happen with <code>F10</code>. If it happens with <code>> F11</code>, its a bug that needs to be fixed upstream (and in that case I always need the output from http://people.freedesktop.org/~whot/evtest) I use output of <code>evtest</code> to write software test devices to simulate the hardware. the repository for that is at [[git://people.freedesktop.org/~whot/testdevices.git]], if the user can program, it’s quite simple to add new devices. (but of course, we should ask them first, and not push mere users to programming). If the device doesn’t send events or doesn’t behave properly, always check the evtest output too. If that one is busted, it’s a kernel or hardware issue. If evtest looks normal, but the server jumps it’s a server issue, often pointer acceleration or scaling


If evtest looks normal, but the server jumps it’s a server issue, often pointer acceleration or scaling
=== Fedora 12 or earlier ===
# is the devices listed with an <code>input.x11_driver</code> in <code>lshal</code>? no? -> '''hal configuration issue'''
# any <code>input.x11_options</code> by the user? no? - '''hal configuration issue'''. These are hard because they’re usually typos that are hard to spot, but you can probably punt the user to the [[Input_device_configuration|input device configuration]] wiki page and let them sort it out themselves.


== Synaptics bugs ==
== Synaptics bugs ==
Line 27: Line 48:
# anything that says input.capabilities input.touchpad in lshal uses synaptics.
# anything that says input.capabilities input.touchpad in lshal uses synaptics.
# anything else, evdev
# anything else, evdev
[[Category:Debugging|X]]

Latest revision as of 10:41, 23 February 2017

General overview

For Fedora 13 (with xorg-x11-server-1.7.99.901-1) we disabled HAL configuration, so a fair bunch of configuration problems may come from that. The fdi files are now ignored, so the configurations need to be moved. We recommend that they be put as InputClass sections into the xorg.conf (careful when recommending to delete the xorg.conf for other bugs). This needs to be done manually, there's no automatic conversion tool.

Most evdev bugs aren’t actually evdev bugs. they tend to get caught before the releases. They’re either configuration issues (HAL, usually) or server bugs. especially when it comes to keyboard layouts etc., it’s nearly always server.

Also, there are almost no xorg-x11-drv-{mouse,keyboard} bugs. User has to have AutoAddDevices "off", or "AllowEmptyInput" "off" in the config file, so nobody without xorg.conf will use these drivers.

Real evdev bugs are usually when over time something degenerates, when the pointer jumps after pressing a button, things like that, or when the server says “don’t know how to use device” (in Xorg.*.log). In some cases, hardware is partially broken (usually a kernel issue). For those, usually bugs with mice and touchpads, ask for the evtest output of the device. If it's a bug that crashes the server, ask for the evtest-capture output on this device to reproduce.

Therefore most input device bugs are in the xorg-x11-server component, assigned to peter.

Log files

What log files are needed for bug triaging:

  • /var/log/Xorg.0.log (or the Xorg.0.log.old after a crash, it contains the backtrace) is almost *always* needed. Please attach it as a whole, uncompressed. Note that depending on what $DISPLAY the server starts up, the numbers may be different or change after a restart (/var/log/Xorg.1.log, etc.). If you are not sure which one is the right one, check the timestamps on the file.
  • xorg.conf if there is one
  • Fedora 13 or later: custom xorg.conf.d snippets if there are ones
  • Fedora 12 or earlier: output from lshal
  • For keyboard layout issues: the output of "xkbcomp -xkb $DISPLAY -"
  • For any device issues: evtest against the device file
  • For any crashers or misbehavings after a certain series of (hardware) actions: evtest-capture against the device file

Keyboard layouts

  • Some modifier keys stop working, some keys don't repeat, etc. => xorg-x11-server. This must have a simple, seproducible test case, it's near-impossible to debug otherwise. Things like "do something for 20 minutes and then it stops working" isn't enough.
  • A keyboard layout works, but one or two keys provide the wrong symbols => xkeyboard-config, should usually be upstreamed, Peter hands the decisions on layout changes to the upstream maintainer.
  • The user-selected layout does not apply => configuration issue, gnome-settings-daemon, gdm or xorg-x11-server.
    • Does the layout from /etc/sysconfig/keyboard show up in the Xorg.log file (only for keyboard devices, devices like the Power Button or Video Bus stay on 'us')? no? => system-setup-keyboard
    • Do user-configured options (in custom .fdi files) show up in the Xorg.log file? no? => hal configuration needs porting to xorg.conf format.
    • Do user-configured options (in xorg.conf/xorg.conf.d) show up in the Xorg.log file? no? => xorg-x11-server
    • Does the layout work in a plain X session (yum install xterm && sudo init 3 && xinit --)? no? => xorg-x11-server
    • Does the layout work in a plain X session but stops working after login? => gnome-settings-daemon or possibly gdm
  • Arrow keys broken (up == printscreen): this is caused by an xfree86 (or "base") ruleset for an evdev device. The cause of this is almost always a stray AllowEmptyInput "off" in the config (which is nearly always a wrong configuration). Removing the option fixes it.

How to spread bugs between evdev, -mouse or -keyboard and kernel

  1. is the device listed in /proc/bus/input/devices? no? -> kernel
  2. does the device match any InputClass sections in /etc/xorg.conf.d/? no? -> configuration issue
  3. are there any user-configured options in the xorg.conf or /etc/xorg.conf.d but they're not merged? -> configuration issue or xorg-x11-server
  4. if the Xorg.log lists the device when it appears and says “don’t know how to use device” that means the device is not detected by evdev. It shouldn’t happen with >= F11 or rawhide, can still happen with F10. If it happens with > F11, its a bug that needs to be fixed upstream (and in that case I always need the output from http://people.freedesktop.org/~whot/evtest) I use output of evtest to write software test devices to simulate the hardware. the repository for that is at [[1]], if the user can program, it’s quite simple to add new devices. (but of course, we should ask them first, and not push mere users to programming). If the device doesn’t send events or doesn’t behave properly, always check the evtest output too. If that one is busted, it’s a kernel or hardware issue. If evtest looks normal, but the server jumps it’s a server issue, often pointer acceleration or scaling

Fedora 12 or earlier

  1. is the devices listed with an input.x11_driver in lshal? no? -> hal configuration issue
  2. any input.x11_options by the user? no? - hal configuration issue. These are hard because they’re usually typos that are hard to spot, but you can probably punt the user to the input device configuration wiki page and let them sort it out themselves.

Synaptics bugs

Another thing about evtest—synaptics won’t spit out any events to evtest while X is running because the device file is grabbed. so you need to VT switch away to get the events from the hardware. For evdev devices, that’s not a problem (now, evdev used to grab too until mid-F10).

  1. anything that says input.capabilities input.touchpad in lshal uses synaptics.
  2. anything else, evdev