Bug 280377 - usbhid(4) man page does tell where the debug output goes
Summary: usbhid(4) man page does tell where the debug output goes
Status: In Progress
Alias: None
Product: Base System
Classification: Unclassified
Component: usb (show other bugs)
Version: 14.1-RELEASE
Hardware: Any Any
: --- Affects Many People
Assignee: Ed Maste
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-07-19 21:12 UTC by Anton Shepelev
Modified: 2025-11-12 21:15 UTC (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Anton Shepelev 2024-07-19 21:12:32 UTC
The usbhid(4) man page:
  <https://man.freebsd.org/cgi/man.cgi?query=usbhid&sektion=4>
documents a sysctl for the debug level:
  hw.usb.usbhid.debug
but neglects to say where the debug messages are sent. Please,
specify this information. An extra phrase in the man-page will save
many users, especially new ones, a lot of guesswork.
Comment 1 Ed Maste freebsd_committer freebsd_triage 2024-07-26 17:32:34 UTC
Debug info will be send to the system console (and appear in dmesg). All USB functionality uses common functionality implemented in sys/dev/usb/usb_debug.h. Indeed it would be good for this to be described in one or more manpages.
Comment 2 Anton Shepelev 2024-07-27 22:33:04 UTC
(In reply to Ed Maste from comment #1)

Then I think there may be two solutions:

  1.  add the same text for the debug option to every tool
      using sys/dev/usb/usb_debug.h,

  2.  add a generic man-page (usb-dbg, usb-gen?) documenting
      the features common to all USB-related tools, and
      refer to it.
Comment 3 commit-hook freebsd_committer freebsd_triage 2025-10-02 16:52:21 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=44f3e9f7f6c9afed33d2967c1ed48361bb6b404b

commit 44f3e9f7f6c9afed33d2967c1ed48361bb6b404b
Author:     Ed Maste <emaste@FreeBSD.org>
AuthorDate: 2025-10-02 16:50:15 +0000
Commit:     Ed Maste <emaste@FreeBSD.org>
CommitDate: 2025-10-02 16:51:58 +0000

    usbhid.4: Note where debug messages go

    PR:             280377
    Sponsored by:   The FreeBSD Foundation

 share/man/man4/usbhid.4 | 2 ++
 1 file changed, 2 insertions(+)
Comment 4 commit-hook freebsd_committer freebsd_triage 2025-10-17 17:46:32 UTC
A commit in branch stable/15 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=bf65752dcec9f246eaf4fad6160ec9e7954d5f19

commit bf65752dcec9f246eaf4fad6160ec9e7954d5f19
Author:     Ed Maste <emaste@FreeBSD.org>
AuthorDate: 2025-10-02 16:50:15 +0000
Commit:     Ed Maste <emaste@FreeBSD.org>
CommitDate: 2025-10-17 17:46:03 +0000

    usbhid.4: Note where debug messages go

    PR:             280377
    Sponsored by:   The FreeBSD Foundation

    (cherry picked from commit 44f3e9f7f6c9afed33d2967c1ed48361bb6b404b)

 share/man/man4/usbhid.4 | 2 ++
 1 file changed, 2 insertions(+)