Mention atf(7) in tests(7).
Details
Details
- Reviewers
ngie - Group Reviewers
manpages - Commits
- rS348514: Make tests(7) point people at the atf(7) man page.
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 24035 Build 22920: arc lint + arc unit
Event Timeline
Comment Actions
I’m a bit ambivalent about this change, because it’s up on the wiki in greater detail: https://wiki.freebsd.org/TestingFreeBSD . kyua(1) references atf(7) IIRC, but it’s a level of indirection.
My point is, I’d personally prefer not mentioning just ATF in tests(7), but I want it to be enough of a living document where multiple sources can contribute to it, but mentioning the wiki page doesn’t seem like something that’s generally done from a manpage because the location and content in a wiki page can change.
Comment Actions
The kyua(1) man page does reference atf... in a way - it just .Xrs to it, without mentioning it in the text itself. And yeah, the Wiki does include some more detail, but I always view it as kind of additional source - I know I went for the man page first, and simply pointing me in the right direction would spare me some work. Basically - 'man tests' is the first place I'd look for information on tests. And as it is now, it mentions how to run them, but not how to write them.
Also - the Wiki does mention ATF, but it also mentions Kyua, and that's not a reason to not mention Kyua in tests(7) :-)
| share/man/man7/tests.7 | ||
|---|---|---|
| 61 | Could this be rewritten as: For information on how to write tests with ATF, see .Xr atf 7 . ? | |
| share/man/man7/tests.7 | ||
|---|---|---|
| 61 | Or maybe an unordered list here might be a good idea in the longterm with a list of all of the supported formats, but I think this is ok for now. | |
| share/man/man7/tests.7 | ||
|---|---|---|
| 61 | I think I like my version better - if the reader heard about ATF, they don't need this sentence anyway. | |