MODULE_PNP_INFO(9): add example of T usage

[0mp]

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).

[cem]

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.)

[yuripv]

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 :-)

[cem]

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]

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.

[imp]

seems good to me from a content perspective.

[yuripv]

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]

Address review comments.

[0mp]

Looks good to me.

share/man/man9/MODULE_PNP_INFO.9

161 ↗

(On Diff #48458)

Good point! I'm working on it: https://wiki.freebsd.org/MateuszPiotrowski/MdocStyleGuide

[yuripv]

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

[0mp]

@yuripv_yuripv.net, I'll take it.

[0mp]

I am awaiting approval from re@ now.

[0mp]

@yuripv_yuripv.net, committed! Thanks!