Page MenuHomeFreeBSD

Update tests(7) as it was imported to base in r359260
ClosedPublic

Authored by lwhsu on Jun 18 2020, 3:19 PM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 11 2024, 2:23 AM
Unknown Object (File)
Dec 25 2023, 9:19 PM
Unknown Object (File)
Dec 25 2023, 9:19 PM
Unknown Object (File)
Dec 25 2023, 9:19 PM
Unknown Object (File)
Dec 21 2023, 6:46 AM
Unknown Object (File)
Dec 20 2023, 5:28 AM
Unknown Object (File)
Nov 26 2023, 5:11 PM
Unknown Object (File)
Nov 8 2023, 3:47 PM
Subscribers

Details

Summary

Update tests(7) as it was imported to base in r359260

https://bugs.freebsd.org/247151

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 31796
Build 29357: arc lint + arc unit

Event Timeline

lwhsu requested review of this revision.Jun 18 2020, 3:19 PM
markj added inline comments.
share/man/man7/tests.7
106

Shouldn't it be kyua(1)?

This revision is now accepted and ready to land.Jun 18 2020, 3:21 PM
This revision now requires review to proceed.Jun 18 2020, 3:23 PM
lwhsu added inline comments.
share/man/man7/tests.7
106

Yeah, was thinking kyua.conf(5).

This revision is now accepted and ready to land.Jun 18 2020, 3:25 PM
bcr added a subscriber: bcr.

OK from manpages.

0mp requested changes to this revision.Jun 18 2020, 6:51 PM
0mp added inline comments.
share/man/man7/tests.7
106

BTW, do we even need to mention that it is installed here? That's probably what our users assume anyway when a tool is mentioned in a manual from the base system.

109

Usually we use the Fx macro like this:

.Fx 13.0
210

I'd just replace the argument to -width with "/etc/kyua/kyua.conf".

This revision now requires changes to proceed.Jun 18 2020, 6:51 PM
share/man/man7/tests.7
106

I'm neutral about this. I added this to follow the "Installing the test suite" section. Maybe we can move both of them to HISTORY section?

109

Got it, it was also following "Installing the test suite" section, I will change both of them.

210

I found this results one space difference:

.Bl -tag -compact -width etcXkyuaXkyuaXconfXX
     /etc/kyua/kyua.conf   System-wide configuration file for kyua(1).
                        ^^^
.Bl -tag -compact -width "/etc/kyua/kyua.conf"
     /etc/kyua/kyua.conf  System-wide configuration file for kyua(1).
                        ^^

What's the convention in our manual?

share/man/man7/tests.7
106

This part is one of the reasons I didn't write the patch myself ;) I wasn't sure if we want to keep this info or not.

I'd say we can just remove it completely. Or move it to a history section, but that would not be a blocker for me.

210

This is expected. Usually we set -width to literal a fixed string indent, which gives some reasonable default (it is interpreted by mandoc in a special way), or we pass the longest tag in the list as an argument to -width (like in this case). The second option always results in 2 spaces as you discovered.

If neither of those two approaches gives a list that is nice looking, then we adjust the set -width to whatever increases the readability.

Move histories to HISTORY section.
Adjust -width parameter

Add missing .Pp
Adjust wording.

LGTM! Thank you!

share/man/man7/tests.7
235
  • Usually the history section is written in past tense.
  • Fx is meant to be used like this: .Fx 11.0. I don't know what's the benefit, but this is what mdoc(7) says.

How about:

The
.Fx
Test Suite first appeared in
.Fx 10.1 
and became part of the base system in
.Fx 11.0 .
.Pp
The test driver,
.Xr kyua 1 ,
first appeared in the base system in
.Fx 13.0 ,
previously being available only in
.Xr ports 7 .
This revision is now accepted and ready to land.Jun 19 2020, 7:44 AM
share/man/man7/tests.7
250

Maybe s/by default/as part of the base system/?

I appreciate this update.

One thing that might be worth mentioning is that kyua(1) is still available from ports(7), as well as in the base system.

share/man/man7/tests.7
250

Agreed.