'\" t
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1996-2000, 2002, 2004-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1997, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.ds n) aegis
.ds N) Aegis
.if n .nr )M 8n
.if n .nr IN 8n
.if n .nr )I 8n
.if n .po 0
.hy 0
.if n .ad l
.de r)
.if !'\\*(R)'no' \{\
.PP
See also
.IR \*(n) (1)
for options common to all \*(n) commands.
.\}
..
.de eB
.RS
.nf
.ft CW
.ta 8n 16n 24n 32n
..
.de eE
.ft P
.fi
.RE
..
.TH "\*(n) -Test" 1 \*(N) "Reference Manual"
.SH NAME
aegis test \- run tests
.XX "aet(1)" "run tests"
.SH SYNOPSIS
.B \*(n)
.B -Test
[
.IR option ...
][
\fIname\fP\fB=\fP\fIvalue\fP
][
.IR file-name ...
]
.br
.B \*(n)
.B -Test
.B -INDependent
[
.IR option ...
][
\fIname\fP\fB=\fP\fIvalue\fP
][
.IR file-name ...
]
.br
.B \*(n)
.B -Test
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -Test
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -Test
command is used to
run tests.
If no files are named, all relevant tests are run.
By default both automatic and manual tests are run.
.PP
You may name directories on the command line, and all relevant tests in
that directory tree in the change will be run.
It is an error if there are no relevant tests.
.PP
Each architecture must be tested separately.
This is because there may be subtle problems that are only
revealed on some architectures.
Some projects may also have different code for different architectures.
.PP
The status of the last test run is remembered so that tests are not run
if there is no need.
(This does not apply to
.I -REGression
tests, unfortunately.)
Tests must be re-run
if the test previously failed,
if the test file has changed,
if there has been a build,
and for each architecture.
.SS name=value
You can add \fIname\fP\fB=\fP\fIvalue\fP pairs to the command line,
these will be passed unchanged to the test command.
Usually on the end of the command line, but this can be changed in the
project configuration file.
.PP
The \fB\-force\fP option results in an implicit \f[CW]force=1\fP
variable being added to the list of variable assignments, and thus
added to the end of the command.  This is of most use when using the
\fIbatch_\%test_\%command\fP filed of the project configuration file.
.PP
This may initially look like a development process end-run,
allowing test scripts to be written so that they
give all the right answers without actually doing anything.
You have always been able to do this with environment variables,
so this isn't anything new.
.PP
It is possible to get all of the variable assignments to turn into
environment variables by putting \f[CW]$var\fP at the \fIstart\fP of the
command, before the name of the shell, rather than at the default
location at the end of the command.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1999, 2002, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.SS File Name Interpretation
The \*(n) program will attempt to determine the project file names
from the file names given on the command line.
All file names are stored within \*(n) projects as relative to
the root of the baseline directory tree.
The development directory and the integration directory are shadows of
this baseline directory, and so these relative names apply here, too.
Files named on the command line
are first converted to absolute paths if necessary.
They are then compared with the baseline path,
the development directory path,
and the integration directory path,
to determine a baseline-relative name.
It is an error if the file named is outside
one of these directory trees.
.PP
The \fB-BAse_RElative\fP option may be used to cause relative filenames
to be interpreted as relative to the baseline path; absolute filenames
will still be compared with the various paths in order to determine a
baseline-relative name.
.PP
The \fIrelative_filename_preference\fP in the user configuration file
may be used to modify this default behavior.  See \fIaeuconf\fP(5) for
more information.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1996, 2005-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.SH TEST PROCESS
Each change is required to be accompanied by tests, and those tests are
required to be run against the built development directory, and they
must pass.  This ensures that new functionality is accompanied by tests
to verify its correctness, and bug fixes are accompanied by tests which
confirm that the bug has been fixed.
.SS Regression Tests
Tests are treated as any other source file, and are maintained in the
baseline and history with all other source files.  The tests which must
accompany every change accumulate in the project baseline, providing a
definition of correct function for the baseline.  These accumulated
tests may be executed using an \[lq]\*(n) -REGression\[rq] command, to verify
that the project will not \[lq]regress\[rq] as a result of a change.
.SS Baseline Tests
Bug fixes are required to have their tests
.I fail
against the project baseline (in contrast to the development directory).
This ensures that the test actually demonstrates the bug in the
baseline, as well as demonstrating that it is fixed by the change.  New
functionality trivially fails against the baseline, and so \*(n) does
not attempt to guess if a test is a bug fix test or new functionality
test, it simply requires tests to fail against the baseline.
.PP
This requirement applies both to new tests being created by a change and
also to tests which have been copied into a change for modification.
.SS Reviewing Tests
Reviewers may be confident that \*(n) has enforced the test
requirements; that a change must have tests, that the change must build,
that the tests pass against the development directory, and that the
tests fail against the baseline.  These conditions are enforced by
.IR aede (1)
and the change will not be advanced to the
.I "being reviewed"
state until these conditions are met.  Reviewers should thus review
tests for
.I completeness
of coverage of the code in the change, and insensitivity to changes in
the execution environment (e.g. not date sensitive).  Reviewers should
also use \[lq]\*(n) -list change_details\[rq] to verify that a change does or
does not have testing exemptions.
.SS Exemptions
Various test exemptions may be granted by project administrators, see
.IR aepa (1)
and
.IR aepattr (5)
for more information.
Copying tests into a change, or adding new tests to a change,
may cancel those exemptions.
.SH "TEST COMMAND CONFIGURATION"
.PP
The command used to execute tests is defined by the
.I test_command
field in the project
configuration
file (see
.IR aepconf (5)
for more information),
this defaults to using the Bourne shell if not set.
The current directory will be the top of the appropriate directory tree.
If tests require temporary files, they should create them in
.IR /tmp ,
as a test cannot expect to have write permission
in the current directory.
.PP
If you want to use a more sophisticated test engine, rather than a
simple shell script, but this test engine does not return result codes
suitable for use with \*(n), you could wrap it in a shell script which
re-writes the exit status into the values \*(n) expects.
You could also achieve the same results by writing a more complex
.I test_command
in the project
.I config
file.
.PP
It is also possible to write test commands which are able to
test more than one file at once.  This is controlled by the
\fIbatch_\%test_\%command\fP field of the project \fIconfig\fP file.
In this case, the ${output} substitution indicates the name of a file
the test command must create, in \fIaetest\fP(5) format, to contain the
results of the tests run.  This is often used on systems with multiple
CPUs or the ability to distribute jobs across several computers on
a network.
.SS "Substitutions"
All of the \fIaesub\fP(5) substitutions are available in the test commands.
Some of them are of particular note:
.TP 8n
.I ARCHitecture
This substitution is replaced by the name of the architecture to be
tested.
.TP 8n
.I Search_Path
This substitution is replaced by a colon separated list of absolute
paths to search when looking for test support files.
.TP 8n
.I Search_Path_Executable
This substitution is replaced by a colon separated list of absolute
paths to search when looking for executable support files (library files
and sub-commands).
.PP
Most of the time \fI$Search_Path_Executable\fP are exactly the same.
However, during \[lq]aegis -t -bl\[rq] they will be different, with
\fI$Seach_Path\fP starting at the development directory (the test
being run) and \fI$Seach_Path_Executable\fP starting at the baseline
(the executable being run).
.SS "Test Result Codes"
As each test is run
(via the
.I test_command
field in the project
.I config
file),
\*(n) determines whether the test succeeded or failed by looking at its
exit status.
This exit status is mostly as expected for UNIX commands.
.TP 4n
Success
A test should exit 0 to indicate success,
i.e. that the specific function under test worked as expected.
.TP 4n
Failure
A test should exit 1 to indicate failure,
i.e. that the specific function under test did not work as expected.
.TP 4n
No Result
A test should exit 2 to indicate no result,
\fIi.e.\fP that the specific function under test could not be exercised
because something else went wrong.
For example, running out of disk space when creating the test input
files in the
.I /tmp
directory.
.TP 4n
Skipped
A test should exit 77 to indicate that it was skipped.
This is usually to do with the current architecture not being meaningful.
Whenever possible, use \[lq]No Result\[rq] instead.
(The value was chosen for compatibility with other test systems.)
.PP
Actually, any exit code other than 0, 1 or 77 will be interpreted as \[lq]no
result\[rq].  However, always using 0, 1, 2 or 77 means that if a new result
code is required by a later release of Aegis your existing tests will
continue to work.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1996, 1999, 2002, 2005-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.SH TEST CORRELATIONS
The \[lq]\*(n) -Test -SUGgest\[rq] command may be used to have \*(n)
suggest suitable regression tests for your change, based on the source
files in your change.  This automatically focuses testing effort
to relevant tests, reducing the number of regression tests
necessary to be confident that you have not introduced a bug.
.PP
The test correlations are generated by the \[lq]\*(n)
-Integrate_Pass\[rq] command, which associates each test in the
change with each source file in the change.  Thus, each source
file accumulates a list of tests which have been associated with
it in the past.  This is not as exact as code coverage analysis,
but is a reasonable approximation in practice.
.PP
The
.IR aecp (1)
and
.IR aenf (1)
commands are used to associate files with a change.  While they
do not actively perform the association, these are the files
used by
.IR aeipass (1)
and
.IR aet (1)
to determine which source files are associated with which tests.
.SS Test Correlation Accuracy
Assuming that the testing correlations are accurate and that the
tests are evenly distributed across the function space, there
will be a less than \fI1/number\fP chance that a relevant test
has not been run by the \[lq]\*(n) -Test -SUGgest \fInumber\fP\[rq]
command.  A small amount of noise is added to the test
weighting, so that unexpected things are sometimes tested, and
the same tests are not run every time.
.PP
Test correlation accuracy can be improved by ensuring that:
.TP 2m
\(bu
Each change should be strongly focused, with no gratuitous file
inclusions.  This avoids spurious correlations.
.TP 2m
\(bu
Each item of new functionality should be added in an individual change,
rather than several together.  This strongly correlates tests with
functionality.
.TP 2m
\(bu
Each bug should be fixed in an individual change, rather than several
together.  This strongly correlates tests with functionality.
.TP 2m
\(bu
Test correlations will be lost if files are moved.  This is because
correlations are by name.
.PP
The best way for tests to correlate accurately with source files is when
a change contains a test and exactly those files relating to the
functionality under test.  Too many spurious files will weaken the
usefulness of the testing correlations.
.SH OPTIONS
The following options are understood:
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1999, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -AUTOmatic
This option may be used to specify automatic tests.
Automatic tests require no human assistance.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -BaseLine
This option may be used to specify that
the project baseline is the subject of the command.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1998, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B \-BAse_RElative
This option may be used to cause relative filenames to be considered
relative to the base of the source tree.
See \fIaeuconf\fP(5) for the corresponding user preference.
.TP 8n
.B \-CUrrent_RElative
This option may be used to cause relative filenames to be considered
relative to the current directory.  This is usually the default.
See \fIaeuconf\fP(5) for the corresponding user preference.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2003, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
\fB-Change\fP \fInumber\fP
This option may be used to specify a particular change within a project.
See \fIaegis\fP(1) for a complete description of this option.
.TP 8n
.B -FOrce
This option may be used to specify that all tests should be run,
even if the status of the last test run indicates that there is no
need to run a specific test.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -Help
.br
This option may be used to obtain more information about how to use the
.I \*(n)
program.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -INDependent
This option is used to specify that the test is to be run independent
of any particular change.
If no tests are named,
all tests in the baseline will be run.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -List
.br
This option may be used to obtain a list of suitable subjects for this
command.
The list may be more general than expected.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1999, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -MANual
This option may be used to specify manual tests.
Manual tests require some human intervention,  e.g.:
confirmation of some screen behavior (X11, for instance),
or some user action, "unplug ethernet cable now".
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1992, 1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -Not_Logging
.br
This option may be used to disable the automatic logging of
output and errors to a file.
This is often useful when several \*(n) commands are combined
in a shell script.
.TP 8n
.B -PErsevere
This option may be used to specify that all tests should be run,
even if some fail.
Defaults to the user's
.I persevere_preference
if not specified, see
.IR aeuconf (5)
for more information.
.TP 8n
.B -No_PErsevere
This option may be used to specify that the test run should
stop after the first failure.
Defaults to the user's
.I persevere_preference
if not specified, see
.IR aeuconf (5)
for more information.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
\fB-Project\fP \fIname\fP
This option may be used to select the project of interest.
When no
.B -Project
option is specified,
the
.I AEGIS_PROJECT
environment variable is consulted.
If that does not exist,
the user's
.I $HOME/.aegisrc
file is examined for a default project field (see
.IR aeuconf (5)
for more information).
If that does not exist,
when the user is only working on changes within a single project,
the project name defaults to that project.
Otherwise,
it is an error.
.TP 8n
.B -PROGress
This option may be used to specify that progress messages should be
issued before each test run or before each batch test run in case
.I batch_test_command
field specified in project
.I config
file (see
.IR aeuconf (5)
for more information).
.TP 8n
.B -No_PROGress
This option may be used to specify that progress messages should be
suppressed.  This is the default.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1994, 1996, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -REGression
This option is used to specify that the
regression test suite is to be run.
The regression test suite consists of all
tests in the baseline which do not appear in the change.
It is an error if there are no regression tests.
You may not name tests on the command line
when using the -REGression option.
You may name individual tests to be run on the command line,
without using the -REGression option;
if they are not part of the change,
the tests of the same name in the baseline will be run.
.TP 8n
\fB-SUGgest\fP [ \fInumber\fP ]
.br
The \[lq]\fI\*(n) -Integrate_Pass\fP\[rq] command collects test
correlation statistics when changes are integrated.
This option may be used to request that \*(n) suggest
which tests should be run, using these testing correlations.
If no number is specified, 10 tests will be suggested.
This option implies the
.B -REGression
option.
.TP 8n
\fB-SUGgest_Limit\fP \fIminutes\fP
.br
This option may be used to limit the number of tests to a certain number
of minutes.  They will be run from most relevant to least relevant.
.TP 8n
\fB-SUGgest_Noise\fP \fInumber\fP
.br
This option may be used to control the amount of noise injected into the
test selection performed by the \fB-SUGgest\fP option.
The number is a percentage of noise to be injected.
Defaults to 10 if not specified.
The injection of noise ensures that a variety of tests are run
on subsequent runs, and also some from left-field as a sanity check.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -TERse
.br
This option may be used to cause listings to
produce the bare minimum of information.
It is usually useful for shell scripts.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B -Verbose
This option may be used to cause \*(n) to produce more output.
By default \*(n) only produces output on errors.
When used with the
.B -List
option
this option causes column headings to be added.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1998, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.TP 8n
.B \-Wait
This option may be used to require \*(N) commands to wait for access
locks, if they cannot be obtained immediately.
Defaults to the user's
.I lock_wait_preference
if not specified, see
.IR aeuconf (5)
for more information.
.TP 8n
.B \-No_Wait
This option may be used to require \*(N) commands to emit a fatal error
if access locks cannot be obtained immediately.
Defaults to the user's
.I lock_wait_preference
if not specified, see
.IR aeuconf (5)
for more information.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 2006-2008 Peter Miller.
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.r)
.PP
All options may be abbreviated;
the abbreviation is documented as the upper case letters,
all lower case letters and underscores (_) are optional.
You must use consecutive sequences of optional letters.
.PP
All options are case insensitive,
you may type them in upper case or lower case or a combination of both,
case is not important.
.PP
For example:
the arguments "-project, "-PROJ" and "-p" are
all interpreted to mean the \fB-Project\fP option.
The argument "-prj" will not be understood,
because consecutive optional characters were not supplied.
.PP
Options and other command line arguments may be
mixed arbitrarily on the command line,
after the function selectors.
.br
.ne 4
.PP
The GNU long option names are understood.
Since all option names for
.I \*(n)
are long,
this means ignoring the extra leading '-'.
The "\fB--\fIoption\fB=\fIvalue\fR" convention is also understood.
.SH RECOMMENDED ALIAS
The recommended alias for this command is
.nf
.ta 8n 16n
csh%	alias aet '\*(n) -t \e!* -v'
sh$	aet(){\*(n) -t "$@" -v}
.fi
.SH ERRORS
It is an error if
the change is not in one of the
.I "being developed"
or
.I "being integrated"
states.
.br
It is an error if
the change is not assigned to the current user.
.br
It is an error if
your have no relevant tests and no relevant exemption.
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1993, 1995, 1997, 2004, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.SH EXIT STATUS
The
.I \*(n)
command will exit with a status of 1 on any error.
The
.I \*(n)
command will only exit with a status of 0 if there are no errors.
.SH ENVIRONMENT VARIABLES
See \fIaegis\fP(1) for a list of environment variables which may affect
this command.
See \fIaepconf\fP(5) for the project configuration file's
\fIproject_\%specific\fP field for how to set environment variables for
all commands executed by Aegis.
.br
.ne 1i
.SH SEE ALSO
.TP 8n
.IR aeb (1)
build a change
.TP 8n
.IR aeca (1)
modify the attributes of a change
.TP 8n
.IR aedb (1)
begin development of a change
.TP 8n
.IR aeib (1)
begin integration of a change
.TP 8n
.IR aent (1)
add a new test to a change
.TP 8n
.IR aecp (1)
copy an existing test into a change
.TP 8n
.IR aepconf (5)
project configuration file format
.TP 8n
.IR aeuconf (5)
user configuration file format
.\"
.\"	aegis - project change supervisor
.\"	Copyright (C) 1991-1995, 1997, 2006-2008 Peter Miller
.\"
.\"	This program is free software; you can redistribute it and/or modify
.\"	it under the terms of the GNU General Public License as published by
.\"	the Free Software Foundation; either version 3 of the License, or
.\"	(at your option) any later version.
.\"
.\"	This program is distributed in the hope that it will be useful,
.\"	but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"	GNU General Public License for more details.
.\"
.\"	You should have received a copy of the GNU General Public License
.\"	along with this program. If not, see
.\"	<http://www.gnu.org/licenses/>.
.\"
.br
.ne 2i
.SH COPYRIGHT
.ds v) 4.24.3
.ds V) 4.24.3.D001
.ds o) 0
.ds p) 4.25
.ds u) 4.24
.ds Y) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
\*(n) version \*(V)
.br
.if t .ds C) \(co
.if n .ds C) (C)
Copyright \*(C) \*(Y) Peter Miller
.PP
The \*(n) program comes with ABSOLUTELY NO WARRANTY;
for details use the '\fI\*(n) -VERSion License\fP' command.
This is free software
and you are welcome to redistribute it under certain conditions;
for details use the '\fI\*(n) -VERSion License\fP' command.
.br
.ne 1i
.SH AUTHOR
.TS
tab(;);
l r l.
Peter Miller;E-Mail:;millerp@canb.auug.org.au
\f(CW/\e/\e*\fR;WWW:;http://www.canb.auug.org.au/~millerp/
.TE