Manual Reference Pages - TKAER (1)
tkaer - GUI tool for reviewing Aegis change sets, using TCL/TK
Modified And Moved Files
New And Removed Files
Additional Features For Reviewers.
tkaer command is used to provide an easy and convenient way to review Aegis
change sets. It provides a front[hy]end to other tools which are used to
view the modifications.
Files in the change set are shown in one of four lists. The choice of
list is based on the operation performed on the file by the change
(create, modify, move or remove). Empty lists are not shown. The change
details, as provided by ael(1) may be displayed by clicking on the
MODIFIED AND MOVED FILES
tkdiff is used to show the
differenceces between the change and baseline versions of modified and
moved files. (In the case of moved files, the original name is used to
access the baseline
Double[hy]clicking button 1 on a filename (or pressing the space key when
the filename is highlighted) will show the differences
between the change and the current branch baseline. Holding down button
3 (or pressing the [lq]a[rq] key)
will invoke a pop[hy]up menu presenting the reviewer with a list of
grandparent branches which also contain the file. This is particularly
useful when rolling in branches.
NEW AND REMOVED FILES
New files are viewed by opening a new xterm and using vi (in
read[hy]only mode) to display its contents. This method is also used for
removed files, however it is the baseline version that is displayed (so
that the reviewer can see what has been removed).
ADDITIONAL FEATURES FOR REVIEWERS.
If the change is in the
being reviewed state, the reviewer may open the comments editor by clicking on the
[lq]Comments[rq] button. These comments will be submitted should the
reviewer decide that the review has failed. An outline of the files
included in the change is automatically created.
Once the review is
complete, clicking the [lq]Finished[rq] button results in a dialog box which
will allow the reviewer to pass or fail (via the aerpass(1) and
aerfail(1) commands) the change. Alternatively, the reviewer may
resume reviewing or quit, leaving the change state unmodified. If the
change was not in the
being reviewed state, the [lq]Finished[rq] button simply causes
tkaer to exit.
tkaer may be customised by the .tkaer file. This file is created by
tkaer in the users home directory when it is first run. This newly created
file contains the default configuration as described above, such as the
choice of tools used in reviewing. The configuration file itself is a
tcl script which is executed by the
tkaer script using the tcl [lq]source[rq] command. Each entry takes the form
of a [lq]set[rq] statement which adds an item to the pref array.
This is the tool used to visually display the difference between a
changes modified or moved file and the baseline version.
The default setting is
set pref(diff_command) "tkdiff"
You can change it to
set pref(diff_command) "mgdiff"
If you have the mgdiff(1) command installed.
This is the tool used to visually display a new file or a removed files,
prior contents. The default is vi(1)
This is the font used by both the change details viewer and the review
comments editor. Any available X11 font may be used.
This option may be used to specify a particular change within a project.
See aegis(1) for a complete description of this option.
This option may be used to select the project of interest.
-Project option is specified,
AEGIS_PROJECT environment variable is consulted.
If that does not exist,
$HOME/.aegisrc file is examined for a default project field (see
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.
it is an error.
tkaer command will exit with a status of 1 on any error.
tkaer command will only exit with a status of 0 if there are no errors.
See aegis(1) for a list of environment variables which may affect
See aepconf(5) for the project configuration files
project_ specific field for how to set environment variables for
all commands executed by Aegis.
tkaer contributed by
Scott Finneran <firstname.lastname@example.org>
|Reference Manual ||*(N) (1) ||*(N) |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.