summaryrefslogtreecommitdiffstats
path: root/contrib/atf/atf-sh
diff options
context:
space:
mode:
authorrodrigc <rodrigc@FreeBSD.org>2014-09-30 16:14:02 +0000
committerrodrigc <rodrigc@FreeBSD.org>2014-09-30 16:14:02 +0000
commit10f6e5e9ccf3801cab19a16a4f97eb268b76d97f (patch)
treedb111f95f6a0e5a79d642c2ace2858412c731636 /contrib/atf/atf-sh
parent82aeda321d7053f80a6bc0f560d107786decf47a (diff)
downloadFreeBSD-src-10f6e5e9ccf3801cab19a16a4f97eb268b76d97f.zip
FreeBSD-src-10f6e5e9ccf3801cab19a16a4f97eb268b76d97f.tar.gz
MFC r271875, r272046, r272049, r272056
-> Reference the test case "packs" to fix warnings -> Delete mentions to removed manpages -> Minor fixes to docs Approved by: re (gjb)
Diffstat (limited to 'contrib/atf/atf-sh')
-rw-r--r--contrib/atf/atf-sh/atf-check.116
-rw-r--r--contrib/atf/atf-sh/atf-sh-api.315
-rw-r--r--contrib/atf/atf-sh/atf-sh.117
3 files changed, 24 insertions, 24 deletions
diff --git a/contrib/atf/atf-sh/atf-check.1 b/contrib/atf/atf-sh/atf-check.1
index 06904bc..66f9318 100644
--- a/contrib/atf/atf-sh/atf-check.1
+++ b/contrib/atf/atf-sh/atf-check.1
@@ -26,7 +26,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd June 27, 2010
+.Dd March 2, 2014
.Dt ATF-CHECK 1
.Os
.Sh NAME
@@ -118,15 +118,20 @@ Analyzes standard error (syntax identical to above)
Executes
.Ar command
as a shell command line, executing it with the system shell defined by
-.Va ATF_SHELL
-in
-.Xr atf-config 1 .
+.Va ATF_SHELL .
You should avoid using this flag if at all possible to prevent shell quoting
issues.
.El
.Sh EXIT STATUS
.Nm
exits 0 on success, and other (unspecified) value on failure.
+.Sh ENVIRONMENT
+.Bl -tag -width ATFXSHELLXX -compact
+.It Va ATF_SHELL
+Path to the system shell to be used when the
+.Fl x
+is given to run commands.
+.El
.Sh EXAMPLES
.Bd -literal -offset indent
# Exit code 0, nothing on stdout/stderr
@@ -146,6 +151,3 @@ atf-check -s signal:sigsegv my_program
# Combined checks
atf-check -o match:foo -o not-match:bar echo foo baz
.Ed
-.Sh SEE ALSO
-.Xr atf-config 1 ,
-.Xr atf 7
diff --git a/contrib/atf/atf-sh/atf-sh-api.3 b/contrib/atf/atf-sh/atf-sh-api.3
index d63804c..a30aee7 100644
--- a/contrib/atf/atf-sh/atf-sh-api.3
+++ b/contrib/atf/atf-sh/atf-sh-api.3
@@ -26,7 +26,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd October 13, 2013
+.Dd March 2, 2014
.Dt ATF-SH-API 3
.Os
.Sh NAME
@@ -224,9 +224,8 @@ If
.Va exitcode
is not
.Sq -1 ,
-.Xr atf-run 1
-will validate that the exit code of the test case matches the one provided
-in this call.
+the runtime engine will validate that the exit code of the test case
+matches the one provided in this call.
Otherwise, the exact value will be ignored.
.It Fn atf_expect_fail "reason"
Any failure raised in this mode is recorded, but such failures do not report
@@ -258,9 +257,8 @@ If
.Va signo
is not
.Sq -1 ,
-.Xr atf-run 1
-will validate that the signal that terminated the test case matches the one
-provided in this call.
+the runtime engine will validate that the signal that terminated the test
+case matches the one provided in this call.
Otherwise, the exact value will be ignored.
.It Fn atf_expect_timeout "reason" "..."
Expects the test case to execute for longer than its timeout.
@@ -339,5 +337,4 @@ atf_check -s exit:0 -o match:"^foo$" -e empty 'ls'
.Sh SEE ALSO
.Xr atf-sh 1 ,
.Xr atf-test-program 1 ,
-.Xr atf-test-case 4 ,
-.Xr atf 7
+.Xr atf-test-case 4
diff --git a/contrib/atf/atf-sh/atf-sh.1 b/contrib/atf/atf-sh/atf-sh.1
index 7578ba0..ad77f04 100644
--- a/contrib/atf/atf-sh/atf-sh.1
+++ b/contrib/atf/atf-sh/atf-sh.1
@@ -26,7 +26,7 @@
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd October 15, 2013
+.Dd March 2, 2014
.Dt ATF-SH 1
.Os
.Sh NAME
@@ -47,10 +47,8 @@ library.
.Pp
.Nm
is not a real interpreter though: it is just a wrapper around
-the system-wide shell defined by the
-.Sq atf_shell
-configuration value in
-.Xr atf-config 1 .
+the system-wide shell defined by
+.Va ATF_SHELL .
.Nm
executes the interpreter, loads the
.Xr atf-sh-api 3
@@ -68,7 +66,10 @@ The following options are available:
.It Fl h
Shows a short summary of all available options and their purpose.
.El
+.Sh ENVIRONMENT
+.Bl -tag -width ATFXSHELLXX -compact
+.It Va ATF_SHELL
+Path to the system shell to be used in the generated scripts.
+.El
.Sh SEE ALSO
-.Xr atf-config 1 ,
-.Xr atf-sh-api 3 ,
-.Xr atf 7
+.Xr atf-sh-api 3
OpenPOWER on IntegriCloud