tests.7: Provide better examples
Needs ReviewPublic
Actions

Authored by des on Fri, Apr 17, 6:11 PM.

Details

Reviewers

ziaee
ngie

Group Reviewers

srcmgr
manpages
tests

Summary

Previous authors appear to have prioritized brevity over clarity. This
unfortunately resulted in a manual page that left its reader with the
false impression that Kyua is difficult to use. Attempt to correct
this by providing more and simpler examples with longer explanations.

While here, correct outdated information about where Kyua stores its
logs and results.

MFC after: 1 week

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 72323
Build 69206: arc lint + arc unit

Event Timeline

des created this revision.Fri, Apr 17, 6:11 PM

Herald added subscribers: ziaee, imp. · View Herald TranscriptFri, Apr 17, 6:11 PM

des requested review of this revision.Fri, Apr 17, 6:11 PM

Harbormaster completed remote builds in B72294: Diff 175773.Fri, Apr 17, 6:11 PM

des added a reviewer: tests.Fri, Apr 17, 6:55 PM

LGTM from manpages. If you have a moment the https://reviews.freebsd.org/D56153 you requested is awaiting your review.

This revision is now accepted and ready to land.Fri, Apr 17, 7:18 PM

ngie accepted this revision.Sat, Apr 18, 1:50 AM

ngie added a subscriber: ngie.

ngie added inline comments.

share/man/man7/tests.7
149–153	I would note that `kyua debug` doesn't automatically clean up the sandbox kyua makes at test completion (or just point someone to `man 1 kyua`).