tmpdir: fix usage message ref to TMPDIR formal param

[autopkgtest.git] / doc / README.package-tests

diff --git a/doc/README.package-tests b/doc/README.package-tests
index 97b2b84692281be521db41c0a74ebd0eff697d4f..3d47035b95e83d5ccf0102fe7f30185ca804a79d 100644 (file)
--- a/doc/README.package-tests
+++ b/doc/README.package-tests
@@ -11,7 +11,7 @@ debian/tests/control. This is a file containing zero or more
 RFC822-style stanzas, along these lines:
 
         Tests: fred bill bongo
-        Restrictions: needs-root breaks-computer
+        Restrictions: needs-root breaks-testbed
 
 This example defines three tests, called `fred', `bill' and `bongo'.
 The tests will be performed by executing debian/tests/fred,
@@ -20,9 +20,9 @@ with status 0 and print nothing to stderr; if a test exits nonzero, or
 prints to stderr, it is considered to have failed.
 
 The cwd of each test is guaranteed to be the root of the source
-package which will have been built.  HOWEVER note that the tests must
-test the INSTALLED version of the program.  Tests may not modify the
-source tree (and may not have write access to it).
+package, which will have been unpacked but not built.  HOWEVER note
+that the tests must test the INSTALLED version of the program.  Tests
+may not modify the source tree (and may not have write access to it).
 
 If the file to be executed has no execute bits set, chmod a+x is
 applied to it (this means that tests can be added in patches without
@@ -53,16 +53,16 @@ The fields which may appear in the RFC822-style stanza are:
     this stanza.  Depending on the test environment capabilities, user
     requests, and so on, restrictions can cause tests to be skipped or
     can cause the test to be run in a different manner.  Tests which
-    declare unknown restrictions will be skipped.
+    declare unknown restrictions will be skipped.  See below for the
+    defined restrictions.
 
   Features: <feature-name> [<another-feature-name> ...]
 
     Declares some additional capabilities or good properties of the
     tests defined in this stanza.  Any unknown features declared will
-    be completely ignored.  Currently there are no defined features
-    but this field is recognised and ignored for future expansion.
+    be completely ignored.  See below for the defined features.
 
-  Depends: <dpkg dependcy field syntax>
+  Depends: <dpkg dependency field syntax>
 
     Declares that the specified packages must be installed for the
     test to go ahead.  `@' stands for the package(s) generated by the
@@ -118,3 +118,13 @@ The defined Restrictions are:
 
     The test script must be run as root.
 
+  build-needed
+
+    The tests need to be run from a built source tree.  The test
+    runner will build the source tree (honouring the source package's
+    build dependencies), before running the tests.  However, the tests
+    are NOT entitled to assume that the source package's build
+    dependencies will be installed when the test is run.
+
+
+There are no currently defined Features.