Bug 175560
| Summary: | ugen(4) man page contains incorrect device node path | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Andreas Gustafsson <gson> |
| Component: | Books & Articles | Assignee: | Gavin Atkinson <gavin> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
State Changed From-To: open->feedback Hi, and sorry for the delay in responding to this. The issue is that the endpoint ID will be a single digit for endpoints 0-9, and double digits for enpoint 10 and up. I'm not sure it's worth changing the man page to reflect that both of these are possible, do you have any opinion? Responsible Changed From-To: freebsd-doc->gavin Track ----- Forwarded message from Andreas Gustafsson <gson@gson.org> ----- Date: Thu, 15 May 2014 19:26:48 +0300 From: Andreas Gustafsson <gson@gson.org> To: gavin@FreeBSD.org Cc: freebsd-doc@FreeBSD.org, gson@gson.org Subject: Re: docs/175560: ugen(4) man page contains incorrect device node path X-Mailer: VM 8.0.14 under 21.4.1 (i386--netbsdelf) Hi, I'm coming to this from NetBSD, where the endpoint number always consists of two digits. For example, endpoint 0 of device 0 is called /dev/ugen0.00, not /dev/ugen0.0. When I tried to open a ugen endpoint on a FreeBSD system using the same device path I had used on NetBSD, it failed as the device node did not exist. Reading the FreeBSD ugen man page then only added to my confusion, because the pattern "/dev/ugenN.EE" in the man page seemed to exactly match the name that did not work. The FreeBSD ugen device and its man page are derived from the NetBSD ones. I'm not sure why FreeBSD is using a naming scheme incompatible with that of NetBSD, but if this is a deliberate change, then surely the man page should also be changed accordingly. At a minimum, it could be changed to simply say: /dev/ugenN.E Endpoint E of device N. Presumably N can also be larger than 9, and if a single N can denote an multi-digit integer, so can a single E. -- Andreas Gustafsson, gson@gson.org ----- End forwarded message ----- Author: gavin Date: Fri May 16 16:28:09 2014 New Revision: 266261 URL: http://svnweb.freebsd.org/changeset/base/266261 Log: USB endpoints are almost always single-digits, fix the path in the man page to be clearer. PR: docs/175560 Submitted by: Andreas Gustafsson <gson gson.org> MFC after: 3 days Modified: head/share/man/man4/ugen.4 Modified: head/share/man/man4/ugen.4 ============================================================================== --- head/share/man/man4/ugen.4 Fri May 16 16:21:17 2014 (r266260) +++ head/share/man/man4/ugen.4 Fri May 16 16:28:09 2014 (r266261) @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 22, 2012 +.Dd May 16, 2014 .Dt UGEN 4 .Os .Sh NAME @@ -292,10 +292,10 @@ and should be set to .Dv USB_CURRENT_ALT_INDEX . .Sh FILES -.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE" -compact -.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE +.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E" -compact +.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E Endpoint -.Ar EE +.Ar E of device .Ar N . .El _______________________________________________ svn-src-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/svn-src-all To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org" State Changed From-To: feedback->patched Your suggestion is sensible. I've committed this change to head, and will merge it in three days. Author: gavin Date: Thu May 22 21:08:32 2014 New Revision: 266559 URL: http://svnweb.freebsd.org/changeset/base/266559 Log: Merge r266261 from head: USB endpoints are almost always single-digits, fix the path in the man page to be clearer. PR: docs/175560 Submitted by: Andreas Gustafsson <gson gson.org> Modified: stable/10/share/man/man4/ugen.4 Directory Properties: stable/10/ (props changed) Modified: stable/10/share/man/man4/ugen.4 ============================================================================== --- stable/10/share/man/man4/ugen.4 Thu May 22 20:59:38 2014 (r266558) +++ stable/10/share/man/man4/ugen.4 Thu May 22 21:08:32 2014 (r266559) @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 22, 2012 +.Dd May 16, 2014 .Dt UGEN 4 .Os .Sh NAME @@ -292,10 +292,10 @@ and should be set to .Dv USB_CURRENT_ALT_INDEX . .Sh FILES -.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE" -compact -.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE +.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E" -compact +.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E Endpoint -.Ar EE +.Ar E of device .Ar N . .El _______________________________________________ svn-src-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/svn-src-all To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org" Author: gavin Date: Thu May 22 21:10:16 2014 New Revision: 266560 URL: http://svnweb.freebsd.org/changeset/base/266560 Log: Merge r266261 from head: USB endpoints are almost always single-digits, fix the path in the man page to be clearer. PR: docs/175560 Submitted by: Andreas Gustafsson <gson gson.org> Modified: stable/9/share/man/man4/ugen.4 Directory Properties: stable/9/share/man/man4/ (props changed) Modified: stable/9/share/man/man4/ugen.4 ============================================================================== --- stable/9/share/man/man4/ugen.4 Thu May 22 21:08:32 2014 (r266559) +++ stable/9/share/man/man4/ugen.4 Thu May 22 21:10:16 2014 (r266560) @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 22, 2012 +.Dd May 16, 2014 .Dt UGEN 4 .Os .Sh NAME @@ -292,10 +292,10 @@ and should be set to .Dv USB_CURRENT_ALT_INDEX . .Sh FILES -.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE" -compact -.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE +.Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E" -compact +.It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar E Endpoint -.Ar EE +.Ar E of device .Ar N . .El _______________________________________________ svn-src-all@freebsd.org mailing list http://lists.freebsd.org/mailman/listinfo/svn-src-all To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org" State Changed From-To: patched->closed Merged to stable/10 and stable/9, thanks! |
The ugen(4) manpage says: Files /dev/ugenN.EE Endpoint EE of device N. But after connecting a generic USB device with multiple endpoints, no device nodes with names of this form exist: # ls /dev/ugen?.?? ls: No match. How-To-Repeat: Attach a USB device. Run "ls /dev/ugen?.??".