libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.

[unitrunker_unitrunker.net]

Summary

Manual pages for libusb20_open(3) and libusb20_be_device_foreach(3).

See https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=291675

[unitrunker_unitrunker.net]

D54231: libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.
lint fix

[unitrunker_unitrunker.net]

D54231: libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.
lint fix

[lwhsu]

Some quick nits for the first pass.

lib/libusb/libusb20_be_device_foreach.3

3

It's good to have a complete copyright & license header, please use share/examples/mdoc/example.3 as an example.

33

46

If those 2 sections are empty, it's ok to be removed, but having some information here is good.

lib/libusb/libusb20_dev_open.3

3

Same as above.

34

40

53

Same as above.

[unitrunker_unitrunker.net]

D54231: libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.
Copyright

[lwhsu]

Some more nits. I am still thinking if we want to move to standalone manual pages, or extend the current libusb20(3). We can also add .Sh EXAMPLES to libusb20(3).

lib/libusb/Makefile

231–232

We need to remove this if libusb20_dev_open.3 becomes a standalone man page.

262–263

We need to remove this if libusb20_be_device_foreach.3 becomes a standalone man page.

lib/libusb/libusb20_be_device_foreach.3

35

USB access library
.Pq libusb, -lusb

39

should be libusb20_be_device_foreach ?

58

59

lib/libusb/libusb20_dev_open.3

35

39

49

66

67

[unitrunker_unitrunker.net]

D54231: libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.
USB access library

[unitrunker_unitrunker.net]

Done! What next?

[ziaee]

lib/libusb/libusb20_be_device_foreach.3

2

This hyphen was for a long abandoned parser that never worked right. It has been remove

3

We took that out of example(?), style(9), and the licensing guide following what other projects have done.

https://docs.freebsd.org/en/articles/license-guide/

34

Library section is deprecated

[unitrunker_unitrunker.net]

D54231: libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.
lint fix (need clarity on library)

[unitrunker_unitrunker.net]

lib/libusb/libusb20_be_device_foreach.3

34

What is a good way to indicate linker requirements?

[ziaee]

lib/libusb/libusb20_be_device_foreach.3

34

What is a good way to indicate linker requirements?

Remove this section, and put ".Lb libusb" as the first line in SYNOPSIS. This is documented in mdoc(7).

[ziaee]

Also unless we are fixing the policy, you should follow the documented project policy and use the preferred license for new files. This is an ISO standard, many other major projects have done the same thing including the Linux kernel, and there is absolutely zero point in making everyone scroll past the same text for the millionth time.

[unitrunker_unitrunker.net]

I think I found some clarity.
https://lists.freebsd.org/archives/freebsd-hackers/2025-June/004719.html

[unitrunker_unitrunker.net]

D54231: libusb20_dev_open(3) and libusb20_be_device_foreach(3) man pages.
Clip copyright text and place Lb clause under SYNOPSIS.

[ziaee]

lib/libusb/libusb20_be_device_foreach.3

4

The copyright line comes before the SPDX line

19

This needs an introductory sentence. What is this function for? Why does the reader care about it?

lib/libusb/libusb20_dev_open.3

4

The copyright line comes before the SPDX line

19

This needs an introductory sentence. What does this function do? The introductory sentence needs to explain to the user if they want to continue reading this page, or if they need to look for a different page.