X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=runner%2Fadt-run.1;h=ff1a661efae13e3d9ad96d00445b62dfa225d06a;hb=aa43f2a81adb120c1da99919c5b3523ea952d170;hp=9dc4b27e49c99595c937dcaf0bb353343a7452de;hpb=e3ef7cbb4d99f83310b864118b942a776dba8e2b;p=autopkgtest.git

diff --git a/runner/adt-run.1 b/runner/adt-run.1
index 9dc4b27..ff1a661 100644
--- a/runner/adt-run.1
+++ b/runner/adt-run.1
@@ -27,7 +27,7 @@ host.  The package should be installed on the testbed.
 
 .SH PROCESSING INSTRUCTIONS
 .TP
-.BR --tests-tree " " \fIdirectory\fR
+.BR --built-tree " " \fIdirectory\fR
 Specifies that tests from the built source tree
 .IR directory
 should be run.  Note that the packages that would normally be
@@ -43,6 +43,13 @@ satisfy dependencies.  The tests from that built tree will also be run
 should precede options whose dependencies are to be satisfied by the
 binaries it produces.
 .TP
+.BR --unbuilt-tree " " \fIdirectory\fR
+Specifies that tests from the unbuilt source tree
+.IR directory
+should be run.  This is very similar to specifing \fB--source\fR
+except that a directory tree (which should be pristine) is supplied,
+instead of a source package.
+.TP
 .BR --binary " " \fIdeb\fR
 Specifies that \fIdeb\fR should be used.  By default it will be used
 to satisfy dependencies, both during building and testing, but not
@@ -51,10 +58,11 @@ necessarily installed.  The ordering is significant, as for
 .TP
 .I filename
 Bare filename arguments are processed as if
-.BR --tests-tree ", " --source " or " --binary
+.BR --built-tree ", " --source ", " --unbuilt-tree " or " --binary
 was specified; the nature of the argument is guessed from the form of
-the filename.  (So in the case of \fB--tests-tree\fR, either the
-option must be specified, or the filename must end in a slash.)
+the filename.  In the case of \fB--built-tree\fR, either the
+option must be specified, or the filename must end in a slash; two
+slashes at the end are taken to mean \fB--unbuilt-tree\fR.
 .SH PROCESSING OPTIONS
 These affect modify processing instructions.  Unless stated
 otherwise, they affect all subsequent options.
@@ -65,13 +73,13 @@ files on the testbed, or on the host, respectively.  The default is
 \fB--paths-host\fR.
 .TP
 .BR --sources-tests | --sources-no-tests
-Specifies that the tests in subsequent \fB--source\fR arguments should
-(or should not) be run.
+Specifies that the tests in subsequent \fB--source\fR and
+\fB--unbuilt-tree\fR arguments should (or should not) be run.
 .TP
 .BR --built-binaries-filter= \fIpattern\fB,\fIpattern\fB,\fR...
 Specifies that only binaries whose package names match one of the
 specified patterns should be used; others will be ignored.  This
-option applies to subsequent \fB--source\fR arguments.
+option applies to subsequent \fB--source\fR and \fB--unbuilt-tree\fR arguments.
 .TP
 .BR --no-built-binaries
 Specifies that all built binaries should be ignored completely;
@@ -82,7 +90,7 @@ equivalent to
 .B --binaries=ignore | --binaries=auto | --binaries=install
 Specifies that binary package (in subsequently specified
 \fB--binary\fR arguments, or resulting from subsequently specified
-\fB--source\fR arguments and not filtered out) should be ignored, used
+\fB--source\fR or \fB--unbuilt-tree\fR arguments and not filtered out) should be ignored, used
 only to satisfy dependencies, or installed unconditionally,
 respectively.  Equivalent to specifying both
 .BR --binaries-forbuilds " and " --binaries-fortests .
@@ -96,7 +104,7 @@ unconditionally installed, when a source package is built.
 Like \fB--binaries=\fR but only changes the handling during testing:
 packages will be ignored, used for dependencies (including as the
 package under test), or unconditionally installed, when tests are run
-(as a result of either \fB--source\fR or \fB--build-tree\fR).
+(as a result of \fB--source\fR, \fB--built-tree\fR or \fB--unbuilt-tree\fR).
 .SH OTHER OPTIONS
 .TP
 .BI --output-dir " " \fIoutput-dir\fR
@@ -145,6 +153,39 @@ Specifies that the trace log should be written to \fIlogfile\fR
 instead of to \fBlog\fR in \fIoutput-dir\fR or \fItmpdir\fR.
 \fIlog-file\fR is not affected by \fB--paths-testbed\fR.
 .TP
+.BI --summary= summary
+Specifies that a summary of the outcome should be written to
+\fIsummary\fR.  The events in the summary are written to the log
+in any case.
+\fIsummary\fR is not affected by \fB--paths-testbed\fR.
+.TP
+.BR --timeout- \fIwhich\fR = \fIseconds\fR
+Use a different timeout for operations on or with the testbed.  There
+are four timeouts affected by four values of \fIwhich\fR:
+.BR short :
+supposedly
+short operations like setting up the testbed's apt and checking the
+state (default: 100s);
+.BR install :
+installation of packages including dependencies
+(default: 3ks);
+.BR test :
+test runs (default: 10ks); and
+.BR build :
+builds (default:
+100ks).  The value must be specified as an integer number of seconds.
+.TP
+.BR --timeout-factor =\fIdouble\fR
+Multiply all of the default timeouts by the specified factor (see
+\fB--timeout-\fR\fIwhich\fR above).  Only the defaults are affected;
+explicit timeout settings are used exactly as specified.
+.TP
+.BR --debug | -d
+Include additional debugging information in the trace log.  Each
+additional \fB-d\fR increases the debugging level; the current maximum
+is \fB-ddd\fR.  If you like to see what's going on, \fR-d\fB or
+\fR-dd\fB is recommended.
+.TP
 .BI --gnupg-home= dir
 Uses \fIdir\fR as the \fBGNUPGHOME\fR for local apt archive signing.
 The specified directory should not contain keyrings containing other
@@ -169,6 +210,16 @@ Specifies the virtualisation regime server, as a command and arguments
 to invoke.  All the remaining arguments and options after
 .B ---
 are passed to the virtualisation server program.
+.TP
+.BI --set-lang= langval
+When running commands on the testbed, sets the \fBLANG\fR environment
+variable to \fIlangval\fR.  The default in \fBadt-run\fR is to set it
+to \fBC\fR.
+.TP
+.BI --leave-lang
+Suppresses the setting by \fBadt-run\fR of \fBLANG\fR on the testbed.
+This results in tests and builds using the testbed's own normal
+\fBLANG\fR value setting.
 
 .SH OUTPUT FORMAT
 During a normal test run, one line is printed for each test.  This
@@ -242,7 +293,7 @@ well-tested.
 
 .SH AUTHORS AND COPYRIGHT
 This manpage is part of autopkgtest, a tool for testing Debian binary
-packages.  autopkgtest is Copyright (C) 2006-1007 Canonical Ltd and
+packages.  autopkgtest is Copyright (C) 2006-2007 Canonical Ltd and
 others.
 
 See \fB/usr/share/doc/autopkgtest/CREDITS\fR for the list of