qmk/qmk_firmware

[Bug] QMK doctor only checks /etc/udev/rules.d for udev rules.

Open

#9,906 opened on Aug 1, 2020

View on GitHub
 (3 comments) (0 reactions) (1 assignee)C (20,368 stars) (43,867 forks)batch import
bughelp wanted

Description

The doctor command in qmk python library fails to find the correct rules in /usr/lib/udev/rules.d directory.

Describe the Bug

The doctor command in QMK python library only checks a hard coded /etc/udev/rules.d for udev rules. Which works fine if you put your rules there. But these rules can also be located in /usr/lib/udev/rules.d; and actually is the preferred location for linux package managers to drop their udev rules. I recently packaged the python client in archlinux; and also provided neccessary udev rules along with it. After switching to these rules, I noticed I was getting warnings from qmk doctor when I had the correct udev rules in place.

System Information

  • Keyboard: N/A
  • Operating system: Archlinux
  • AVR GCC version: 10.1.0
  • ARM GCC version: 10.1.0
  • QMK Firmware version: 0.9.46
  • Any keyboard related software installed?
    • Karabiner
    • Other:
    • AutoHotKey

Additional Context

I also implemented a quick fix; and issued the pull request #9907

Contributor guide

Tech stack
python
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with udev rulesQMK doctor codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue describes that QMK doctor only checks /etc/udev/rules.d for udev rules, but they can also be in /usr/lib/udev/rules.d. A potential fix is provided in PR #9907, which should be reviewed. The fix likely involves extending the search to include both directories or using a more dynamic method. Look at the doctor code in the QMK Python library (likely in lib/python/qmk/cli/doctor.py) and the linked PR for implementation details.