Skip to content

Commit f9b38b5

Browse files
pgrangePascal Grange
authored and
Pascal Grange
committed
Improve manpage by specifying that -p is for a test pattern, no a test name.
1 parent d4da5f8 commit f9b38b5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/man/man1/bash_unit.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
bash_unit \- run unit tests
66
.SH SYNOPSIS
77
.B bash_unit
8-
[ -p TEST_NAME ... ]
8+
[ -p TEST_PATTERN ... ]
99
.RI TESTS_FILE
1010
.SH DESCRIPTION
1111
bash_unit runs the tests writen in the tests_file given as argument. Tests file format is described below in the TESTS FILE section.
1212

13-
You can limit the tests to be run by naming them with the -p option. This option can be specified mutiple times in order to launch a subset of tests.
13+
You can limit the tests to be run with the -p option. This option can be specified mutiple times in order to launch a subset of tests.
1414
.SH OPTIONS
1515
.TP
16-
.BI \-p " " TEST_NAME
17-
Default bash_unit behaviour is to run every test found in tests_file. This option will limit bash_unit to the specified tests.
16+
.BI \-p " " TEST_PATTERN
17+
Default bash_unit behaviour is to run every test found in tests_file. This option will limit bash_unit to the tests which name matches the specified pattern.
1818
.SH TESTS FILE
1919
TESTS FILE is a bash script only containing functions. There are some
2020
.I RESERVED FUNCTION NAMES

0 commit comments

Comments
 (0)