Page MenuHomeFreeBSD

bus_generic_print_child.9: Document bus_print_domain
Needs ReviewPublic

Authored by jhb on Tue, Jan 7, 5:05 PM.
Tags
None
Referenced Files
F108533429: D48373.diff
Sun, Jan 26, 12:18 AM
Unknown Object (File)
Fri, Jan 24, 4:19 PM
Unknown Object (File)
Wed, Jan 15, 12:57 AM
Unknown Object (File)
Tue, Jan 14, 7:05 AM
Unknown Object (File)
Sun, Jan 12, 8:29 PM
Unknown Object (File)
Sun, Jan 12, 8:42 AM
Unknown Object (File)
Sun, Jan 12, 8:42 AM
Unknown Object (File)
Sun, Jan 12, 5:25 AM
Subscribers

Details

Reviewers
imp
Group Reviewers
manpages
Summary

While here, cross-reference BUS_PRINT_CHILD (and fix a stale reference
to DEVICE_PRINT_CHILD which doesn't exist) and expand the text
describing the role of the helper functions.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 61560
Build 58444: arc lint + arc unit

Event Timeline

jhb requested review of this revision.Tue, Jan 7, 5:05 PM
jhb created this revision.
ziaee added a subscriber: ziaee.
ziaee added inline comments.
share/man/man9/bus_generic_print_child.9
38

Sir, xrefs in document descriptions are broken in many implementations like apropos. We discovered in this https://github.com/freebsd/freebsd-src/pull/1371 , and then I asked if Ingo would be willing to accept it as a bug on the mandoc mailing-tech mailing list that month and the maintainer asked us to not do that and gave us some nice contributions for jail.conf(5). Thank you for your consideration.

share/man/man9/bus_generic_print_child.9
38

Yeah, I noticed this as well (mdoc(7) mentions this limitation), but in this case I was only fixing what is already there. I could just turn it into plain text instead?

@kib btw while documenting this, I do wonder if we shouldn't just merge bus_print_child_domain into bus_print_child_footer?

In D48373#1104032, @jhb wrote:

@kib btw while documenting this, I do wonder if we shouldn't just merge bus_print_child_domain into bus_print_child_footer?

Why? On the principle that it is not used by anything else? But there are already approx. 10 callers of the function.

In D48373#1104076, @kib wrote:
In D48373#1104032, @jhb wrote:

@kib btw while documenting this, I do wonder if we shouldn't just merge bus_print_child_domain into bus_print_child_footer?

Why? On the principle that it is not used by anything else? But there are already approx. 10 callers of the function.

More that if we wanted it to be in all bus drivers, we wouldn't have had to change existing (or future) bus drivers if it is part of the default footer. Perhaps not worth changing at this point.