Hi,

clematis wrote on Tue, May 12, 2020 at 03:06:40AM +0200:

> - Should we update those links?

For the manual pages, that seems clear: if some document is worth
linking to (which i assume it is unless told otherwise, if a link
is currently present in a manual page), then we should provide the
best possible form of the link.

I did not touch source code files, i'll leave the decision whether
it is desirable to change those files and whether it is worth the
effort to the developers working on the code.

> - Should we only refer to the document name/version and people can go an
>   search on whatever document library will be available in the future?  

If a site is stupid enough to keep changing their URIs again and
again, maintenance might become annoying enough that we could just
stop linking to that site, but i felt no urgent need to go that far
just yet.

> For the couple missing I can try to contact them.

If you contact them, please also remind them that changiung URIs
is a terrible idea, particularly for documentation and standards
that other documentation may need to link to.

> (Otherwise there's mirror available if that's acceptable).

I prefer linking from authoritative documentation (including manual
pages) to other authoritative documentation (including official
upstream websites), but if those official upstream websites are
unusable for some reason (like lack of stable URIs), linking to
other trustworthy sources may in some cases be a viable alternative.
It's a matter of judgement in each individual case what is most
helpful for users without causing excessive pain for maintenance.

For now, i committed the following minimal patch.

Note that i preferred linking to HTML pages over directly linking
to ZIP files, even if the main content of the HTML page is a link
to the ZIP file.  The links in the header and footer of the HTML
page may occasionally help users, too.

OpenBSD USB developers: please feel free to tweak further in
whichever way you consider useful.

Yours,
  Ingo


Index: lib/libusbhid/usbhid.3
===================================================================
RCS file: /cvs/src/lib/libusbhid/usbhid.3,v
retrieving revision 1.19
diff -u -p -r1.19 usbhid.3
--- lib/libusbhid/usbhid.3      18 Feb 2019 17:29:43 -0000      1.19
+++ lib/libusbhid/usbhid.3      12 May 2020 12:58:21 -0000
@@ -211,7 +211,7 @@ The default HID usage table.
 .\" .Sh EXAMPLES
 .Sh SEE ALSO
 The USB specifications can be found at:
-.Lk http://www.usb.org/developers/docs/
+.Lk https://www.usb.org/documents/
 .Pp
 .Xr uhid 4 ,
 .Xr usb 4
Index: share/man/man4/cdce.4
===================================================================
RCS file: /cvs/src/share/man/man4/cdce.4,v
retrieving revision 1.25
diff -u -p -r1.25 cdce.4
--- share/man/man4/cdce.4       9 Aug 2019 21:45:02 -0000       1.25
+++ share/man/man4/cdce.4       12 May 2020 12:58:21 -0000
@@ -120,7 +120,7 @@ is running low on mbufs.
 .Xr ifconfig 8
 .Rs
 .%T "Universal Serial Bus Class Definitions for Communication Devices"
-.%U http://www.usb.org/developers/docs/devclass_docs/
+.%U 
https://www.usb.org/document-library/class-definitions-communication-devices-12
 .Re
 .Rs
 .%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller"
Index: share/man/man4/upd.4
===================================================================
RCS file: /cvs/src/share/man/man4/upd.4,v
retrieving revision 1.4
diff -u -p -r1.4 upd.4
--- share/man/man4/upd.4        26 Jun 2015 09:00:37 -0000      1.4
+++ share/man/man4/upd.4        12 May 2020 12:58:21 -0000
@@ -70,8 +70,8 @@ NeedReplacement
 .Xr sensorsd 8 ,
 .Xr sysctl 8
 .Pp
-The USB Power Devices specification can be found at
-.Lk http://www.usb.org/developers/hidpage/
+The USB Power Devices specification can be found at:
+.Lk https://www.usb.org/hid
 .Sh HISTORY
 The
 .Nm
Index: share/man/man4/usb.4
===================================================================
RCS file: /cvs/src/share/man/man4/usb.4,v
retrieving revision 1.199
diff -u -p -r1.199 usb.4
--- share/man/man4/usb.4        17 Dec 2019 13:08:54 -0000      1.199
+++ share/man/man4/usb.4        12 May 2020 12:58:21 -0000
@@ -676,8 +676,8 @@ Human Interface Devices (HID).
 .Xr config 8 ,
 .Xr usbdevs 8
 .Pp
-The USB specifications can be found at
-.Lk http://www.usb.org/developers/docs/
+The USB specifications can be found at:
+.Lk https://www.usb.org/documents
 .Sh HISTORY
 The
 .Nm
Index: share/man/man4/umb.4
===================================================================
RCS file: /cvs/src/share/man/man4/umb.4,v
retrieving revision 1.10
diff -u -p -r1.10 umb.4
--- share/man/man4/umb.4        18 Feb 2020 08:09:37 -0000      1.10
+++ share/man/man4/umb.4        12 May 2020 12:58:21 -0000
@@ -61,7 +61,7 @@ The following devices should work:
 .Xr route 8
 .Rs
 .%T "Universal Serial Bus Communications Class Subclass Specification for 
Mobile Broadband Interface Model"
-.%U http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip
+.%U 
https://www.usb.org/document-library/mobile-broadband-interface-model-v10-errata-1-and-adopters-agreement
 .Re
 .Sh CAVEATS
 Devices which fail to provide a conforming MBIM implementation will

Reply via email to