Bug 244842 - ugen(4) device node naming does not match documentation
Summary: ugen(4) device node naming does not match documentation
Status: Closed FIXED
Alias: None
Product: Base System
Classification: Unclassified
Component: usb (show other bugs)
Version: 12.1-STABLE
Hardware: Any Any
: --- Affects Some People
Assignee: Hans Petter Selasky
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-03-16 10:25 UTC by Andreas Gustafsson
Modified: 2021-06-02 12:25 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andreas Gustafsson 2020-03-16 10:25:54 UTC
In FreeBSD 12.1, the ugen(4) man page says:

FILES
     /dev/ugenN.E                           Endpoint E of device N.

but the actual device nodes naming scheme in 12.1 is entirely
different.  I'm guessing it's something more like this:

     /dev/ugenB.D                           Endpoint 0 of device D of bus B
     /dev/usb/B.D.E                         Endpoint E of device D of bus B

I would prefer to have the code match the man page for backwards
compatibility with earlier FreeBSD versions and consistency with the
other BSDs.  Failing that, please at least make the man page match the
code.
Comment 1 commit-hook freebsd_committer freebsd_triage 2021-05-14 15:19:11 UTC
A commit in branch main references this bug:

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

commit c65e2d7092d6cbaf03721ebe46e51cec4bd6ac0f
Author:     Hans Petter Selasky <hselasky@FreeBSD.org>
AuthorDate: 2021-05-14 14:34:15 +0000
Commit:     Hans Petter Selasky <hselasky@FreeBSD.org>
CommitDate: 2021-05-14 15:14:18 +0000

    Update ugen(4) manual page.

    Fix description of generic USB character devices.

    PR:             244842
    MFC after:      1 week
    Sponsored by:   Mellanox Technologies // NVIDIA Networking

 share/man/man4/ugen.4 | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)
Comment 2 Hans Petter Selasky freebsd_committer freebsd_triage 2021-05-14 15:19:55 UTC
Let me know if the committed change is sufficient.

Thank you!

--HPS
Comment 3 commit-hook freebsd_committer freebsd_triage 2021-06-02 12:25:32 UTC
A commit in branch stable/13 references this bug:

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

commit c7ed836df3153950434d79404224e290a3b14a73
Author:     Hans Petter Selasky <hselasky@FreeBSD.org>
AuthorDate: 2021-05-14 14:34:15 +0000
Commit:     Hans Petter Selasky <hselasky@FreeBSD.org>
CommitDate: 2021-06-02 11:25:20 +0000

    Update ugen(4) manual page.

    Fix description of generic USB character devices.

    PR:             244842
    Sponsored by:   Mellanox Technologies // NVIDIA Networking

    (cherry picked from commit c65e2d7092d6cbaf03721ebe46e51cec4bd6ac0f)

 share/man/man4/ugen.4 | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)