Page MenuHomeFreeBSD

MODULE_PNP_INFO(9): add example of T usage
ClosedPublic

Authored by 0mp on Sep 25 2018, 8:00 PM.
Tags
None
Referenced Files
Unknown Object (File)
Jan 15 2024, 9:31 AM
Unknown Object (File)
Jan 7 2024, 3:49 PM
Unknown Object (File)
Dec 20 2023, 3:48 AM
Unknown Object (File)
Dec 10 2023, 7:04 PM
Unknown Object (File)
Oct 29 2023, 7:20 PM
Unknown Object (File)
Oct 9 2023, 2:24 PM
Unknown Object (File)
Sep 18 2023, 4:20 AM
Unknown Object (File)
Sep 18 2023, 4:18 AM
Subscribers

Details

Summary

Provide an example of specifying common vendor value as it wasn't clear (for me, at least) that it's T that should be used and led me on a fool's quest of re-implementing it.

While here, add 'D:#' to previous example to eat the remaining description string, and pet mandoc a bit (it wasn't happy with order of .Xr in SEE ALSO).

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

cem accepted this revision.EditedSep 25 2018, 8:06 PM

I am unfamiliar with usage of T, but assuming the example provided is correct, I agree that adding an example is a good idea. (And the markup/text changes look good.)

This revision is now accepted and ready to land.Sep 25 2018, 8:06 PM
In D17321#369299, @cem wrote:

I am unfamiliar with usage of T, but assuming the example provided is correct, I agree that adding an example is a good idea. (And the markup/text changes look good.)

This was triggered by https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=231625, and correctly using T (see the really simple patch in there) instead of adding useless fields worked for me, so I *hope* it is correct :-)

In D17321#369321, @yuripv_yuripv.net wrote:

This was triggered by https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=231625, and correctly using T (see the really simple patch in there) instead of adding useless fields worked for me, so I *hope* it is correct :-)

Indeed! I guessed your text was informed from a working use :-).

0mp added a subscriber: 0mp.

Just some minor suggestions you may want to consider. Otherwise, the mdoc part of this change seems fine.

share/man/man9/MODULE_PNP_INFO.9
116 ↗(On Diff #48458)

While here, you may also pet igor: s/that's/that is/.

161 ↗(On Diff #48458)

Just a minor thing bu I'd stylize it in the following way:

.It Sy Example 1\&: No Using Vt W32 No for vendor/device pair:

I'd also change the width of Bl from Dsto "" and add Pp after each line with It.

This is just a suggestion but it makes the examples more readable for me.

seems good to me from a content perspective.

yuripv added inline comments.
share/man/man9/MODULE_PNP_INFO.9
161 ↗(On Diff #48458)

Makes sense, but it would be really nice if we had a (wiki) page describing the preferred style and not just personal preferences :-)

yuripv marked an inline comment as done.

Address review comments.

This revision now requires review to proceed.Sep 26 2018, 11:07 AM

Looks good to me.

share/man/man9/MODULE_PNP_INFO.9
161 ↗(On Diff #48458)
This revision is now accepted and ready to land.Sep 26 2018, 11:59 AM

So.. if this looks all good, can anyone please commit it? :)

0mp edited reviewers, added: yuripv; removed: 0mp.
0mp added reviewers: krion, mat.

@yuripv_yuripv.net, I'll take it.

This revision now requires review to proceed.Sep 27 2018, 12:56 PM

I am awaiting approval from re@ now.

This revision was not accepted when it landed; it landed in state Needs Review.Oct 2 2018, 5:01 PM
This revision was automatically updated to reflect the committed changes.

@yuripv_yuripv.net, committed! Thanks!