Module Name: src
Committed By: gutteridge
Date: Sun Aug 27 19:27:23 UTC 2023
Modified Files:
src/external/bsd/atf/dist/doc: atf-test-case.4
Log Message:
atf-test-case.4: better explain custom metadata properties
Apply upstream change
https://github.com/jmmv/atf/commit/e8021f3b376f72702c612d4ae4eceb1bf70d85c6
(Only differences to upstream are "meta-data" is spelled consistently
with the rest of the project documentation and the date.)
To generate a diff of this commit:
cvs rdiff -u -r1.7 -r1.8 src/external/bsd/atf/dist/doc/atf-test-case.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/external/bsd/atf/dist/doc/atf-test-case.4
diff -u src/external/bsd/atf/dist/doc/atf-test-case.4:1.7 src/external/bsd/atf/dist/doc/atf-test-case.4:1.8
--- src/external/bsd/atf/dist/doc/atf-test-case.4:1.7 Sat Feb 8 19:13:44 2014
+++ src/external/bsd/atf/dist/doc/atf-test-case.4 Sun Aug 27 19:27:23 2023
@@ -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 August 27, 2023
.Dt ATF-TEST-CASE 4
.Os
.Sh NAME
@@ -153,11 +153,7 @@ APIs to implement the test cases.
The standard input of the test cases is unconditionally connected to
.Sq /dev/zero .
.Ss Meta-data
-The following list describes all meta-data properties interpreted
-internally by ATF.
-You are free to define new properties in your test cases and use them as
-you wish, but non-standard properties must be prefixed by
-.Sq X- .
+The following meta-data properties can be exposed via the test case's head:
.Bl -tag -width requireXmachineXX
.It descr
Type: textual.
@@ -271,6 +267,17 @@ test program.
Can optionally be set to zero, in which case the test case has no run-time
limit.
This is discouraged.
+.It X- Ns Sq NAME
+Type: textual.
+Optional.
+.Pp
+A user-defined property named
+.Sq NAME .
+These properties are free form, have no special meaning within ATF, and can
+be specified at will by the test case.
+The runtime engine should propagate these properties from the test case to
+the end user so that the end user can rely on custom properties for test case
+tagging and classification.
.El
.Ss Environment
Every time a test case is executed, several environment variables are
