Fix manlint issues with atf-check(1)
- Use `.Bf Em`/`.Ef` instead of prefixing lines with `.Em`. The forms are equivalent with traditional roff, but unnecessarily verbose. The former form applies the .Em macro to the enclosed block. - Move EXIT_STATUS section down so the section complies with section ordering specified by mdoc(7) and enforced by manlint(1). Bump .Dd for the change MFC after: 1 week Sponsored by: Dell EMC Isilon
This commit is contained in:
parent
b93c1b1a3b
commit
ed20d3f52f
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=314799
@ -22,7 +22,7 @@
|
|||||||
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||||||
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
||||||
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
.Dd October 5, 2014
|
.Dd March 6, 2017
|
||||||
.Dt ATF-CHECK 1
|
.Dt ATF-CHECK 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@ -40,10 +40,12 @@
|
|||||||
executes a given command and analyzes its results, including
|
executes a given command and analyzes its results, including
|
||||||
exit code, stdout and stderr.
|
exit code, stdout and stderr.
|
||||||
.Pp
|
.Pp
|
||||||
.Em Test cases must use
|
.Bf Em
|
||||||
.Em Xr atf-sh 3 Ns ' Ns s
|
Test cases must use
|
||||||
.Em Nm atf_check
|
.Xr atf-sh 3 Ns ' Ns s
|
||||||
.Em builtin function instead of calling this utility directly.
|
.Nm atf_check
|
||||||
|
builtin function instead of calling this utility directly.
|
||||||
|
.Ef
|
||||||
.Pp
|
.Pp
|
||||||
In the first synopsis form,
|
In the first synopsis form,
|
||||||
.Nm
|
.Nm
|
||||||
@ -119,9 +121,6 @@ as a shell command line, executing it with the system shell defined by
|
|||||||
You should avoid using this flag if at all possible to prevent shell quoting
|
You should avoid using this flag if at all possible to prevent shell quoting
|
||||||
issues.
|
issues.
|
||||||
.El
|
.El
|
||||||
.Sh EXIT STATUS
|
|
||||||
.Nm
|
|
||||||
exits 0 on success, and other (unspecified) value on failure.
|
|
||||||
.Sh ENVIRONMENT
|
.Sh ENVIRONMENT
|
||||||
.Bl -tag -width ATFXSHELLXX -compact
|
.Bl -tag -width ATFXSHELLXX -compact
|
||||||
.It Va ATF_SHELL
|
.It Va ATF_SHELL
|
||||||
@ -129,6 +128,9 @@ Path to the system shell to be used when the
|
|||||||
.Fl x
|
.Fl x
|
||||||
is given to run commands.
|
is given to run commands.
|
||||||
.El
|
.El
|
||||||
|
.Sh EXIT STATUS
|
||||||
|
.Nm
|
||||||
|
exits 0 on success, and other (unspecified) value on failure.
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
The following are sample invocations from within a test case.
|
The following are sample invocations from within a test case.
|
||||||
Note that we use the
|
Note that we use the
|
||||||
|
Loading…
Reference in New Issue
Block a user