svn commit: r272049 - in head/contrib/atf: atf-c atf-c++ atf-sh doc

Tue Sep 23 22:29:06 UTC 2014

Author: rodrigc
Date: Tue Sep 23 22:29:03 2014
New Revision: 272049
URL: http://svnweb.freebsd.org/changeset/base/272049

Log:
  Delete mentions to removed manpages
  
  Obtained from:  atf (git 23c570d6f393c76dff041360bb5f7779900c7191)

Modified:
  head/contrib/atf/atf-c++/atf-c++-api.3
  head/contrib/atf/atf-c/atf-c-api.3
  head/contrib/atf/atf-sh/atf-check.1
  head/contrib/atf/atf-sh/atf-sh-api.3
  head/contrib/atf/atf-sh/atf-sh.1
  head/contrib/atf/doc/atf-test-case.4
  head/contrib/atf/doc/atf-test-program.1

Modified: head/contrib/atf/atf-c++/atf-c++-api.3
==============================================================================

--- head/contrib/atf/atf-c++/atf-c++-api.3	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/atf-c++/atf-c++-api.3	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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 November 15, 2013
+.Dd March 2, 2014
 .Dt ATF-C++-API 3
 .Os
 .Sh NAME
@@ -330,9 +330,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 expect_fail "reason"
 Any failure (be it fatal or non-fatal) raised in this mode is recorded.
@@ -368,9 +367,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 expect_timeout "reason"
 Expects the test case to execute for longer than its timeout.
@@ -631,5 +629,4 @@ ATF_INIT_TEST_CASES(tcs)
 .Ed
 .Sh SEE ALSO
 .Xr atf-test-program 1 ,
-.Xr atf-test-case 4 ,
-.Xr atf 7
+.Xr atf-test-case 4

Modified: head/contrib/atf/atf-c/atf-c-api.3
==============================================================================
--- head/contrib/atf/atf-c/atf-c-api.3	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/atf-c/atf-c-api.3	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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 November 15, 2013
+.Dd March 2, 2014
 .Dt ATF-C-API 3
 .Os
 .Sh NAME
@@ -409,9 +409,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_tc_expect_fail "reason" "..."
 Any failure (be it fatal or non-fatal) raised in this mode is recorded.
@@ -443,9 +442,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_tc_expect_timeout "reason" "..."
 Expects the test case to execute for longer than its timeout.
@@ -771,5 +769,4 @@ ATF_TP_ADD_TCS(tp)
 .Ed
 .Sh SEE ALSO
 .Xr atf-test-program 1 ,
-.Xr atf-test-case 4 ,
-.Xr atf 7
+.Xr atf-test-case 4

Modified: head/contrib/atf/atf-sh/atf-check.1
==============================================================================
--- head/contrib/atf/atf-sh/atf-check.1	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/atf-sh/atf-check.1	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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 identica
 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

Modified: head/contrib/atf/atf-sh/atf-sh-api.3
==============================================================================
--- head/contrib/atf/atf-sh/atf-sh-api.3	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/atf-sh/atf-sh-api.3	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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 
 .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

Modified: head/contrib/atf/atf-sh/atf-sh.1
==============================================================================
--- head/contrib/atf/atf-sh/atf-sh.1	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/atf-sh/atf-sh.1	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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

Modified: head/contrib/atf/doc/atf-test-case.4
==============================================================================
--- head/contrib/atf/doc/atf-test-case.4	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/doc/atf-test-case.4	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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 January 13, 2011
+.Dd March 2, 2014
 .Dt ATF-TEST-CASE 4
 .Os
 .Sh NAME
@@ -171,9 +171,7 @@ Type: boolean.
 Optional.
 .Pp
 If set to true, specifies that the test case has a cleanup routine that has
-to be executed by
-.Xr atf-run 1
-during the cleanup phase of the execution.
+to be executed by the runtime engine during the cleanup phase of the execution.
 This property is automatically set by the framework when defining a test case
 with a cleanup routine, so it should never be set by hand.
 .It ident
@@ -251,8 +249,7 @@ the test case is
 .Pp
 If the test case is running as root and this property is
 .Sq unprivileged ,
-.Xr atf-run 1
-will automatically drop the privileges if the
+the runtime engine will automatically drop the privileges if the
 .Sq unprivileged-user
 configuration property is set; otherwise the test case is
 .Em skipped .
@@ -314,7 +311,4 @@ Test cases are always executed with a fi
 .Sq 0022 .
 The test case's code is free to change this during execution.
 .Sh SEE ALSO
-.Xr atf-run 1 ,
-.Xr atf-test-program 1 ,
-.Xr atf-formats 5 ,
-.Xr atf 7
+.Xr atf-test-program 1

Modified: head/contrib/atf/doc/atf-test-program.1
==============================================================================
--- head/contrib/atf/doc/atf-test-program.1	Tue Sep 23 22:27:34 2014	(r272048)
+++ head/contrib/atf/doc/atf-test-program.1	Tue Sep 23 22:29:03 2014	(r272049)
@@ -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 February 6, 2011
+.Dd March 2, 2014
 .Dt ATF-TEST-PROGRAM 1
 .Os
 .Sh NAME
@@ -61,16 +61,17 @@ instead of the test case body; see
 Note that the test case is
 .Em executed without isolation ,
 so it can and probably will create and modify files in the current directory.
-To execute test cases in a controller manner, refer to
-.Xr atf-run 1 ,
-which is the preferred way to run test cases.
+To execute test cases in a controller manner, you need a runtime engine
+that understands the ATF interface.
+The recommended runtime engine is
+.Xr kyua 1 .
 You should only execute test cases by hand for debugging purposes.
 .Pp
 In the second synopsis form, the test program will list all available
 test cases alongside their meta-data properties in a format that is
 machine parseable.
 This list is processed by
-.Xr atf-run 1
+.Xr kyua 1
 to know how to execute the test cases of a given test program.
 .Pp
 The following options are available:
@@ -99,5 +100,4 @@ to the value
 .Ar value .
 .El
 .Sh SEE ALSO
-.Xr atf-run 1 ,
-.Xr atf 7
+.Xr kyua 1
