'\" tp
.\" aegis - project change supervisor
.\" Copyright (C) 1991-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
.\" .
.\"
.\"
.\" 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
.\" .
.\"
.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) -Review_PASS" 1 \*(N) "Reference Manual"
.SH NAME
aegis review pass \- pass a change review
.XX "aerpass(1)" "pass a change review"
.SH SYNOPSIS
.B \*(n)
.B -Review_PASS
[
.IR option ...
]
.br
.B \*(n)
.B -Review_PASS
.B -List
[
.IR option ...
]
.br
.B \*(n)
.B -Review_PASS
.B -Help
.SH DESCRIPTION
The
.I \*(n)
.I -Review_PASS
command is used to
notify \*(n) that a change has passed review.
.PP
The default configuration requires only a single reviewer for each
change set. It is possible to have more than one reviewer, and/or
project specific policies about who may review certain files, by
configuring Aegis to use an external review policy command.
.PP
The state transition performed depends on the settings of
the \f[CW]review_\%policy_\%command\fP field of the project configuration
file and the \f[CW]develop_\%end_\%action\fP field of the project attributes.
.TP 4n
\f[CW]review_policy_command\fP not set:
The change will be advanced from the
.I "being reviewed"
state to the
.I "awaiting integration"
state.
.TP 4n
\f[CW]review_policy_command\fP set:
.RS
The command will be executed, and the exit status examined.
.TP 4n
Zero:
The change will be advanced from the
.I "being reviewed"
state to the
.I "awaiting integration"
state.
.TP 8n
Non-Zero:
.RS
The setting of the \f[CW]develop_\%end_\%action\fP of the project attributes
is examined:
.TP 4n
goto_awaiting_review:
The change will be advanced from the
.I "being reviewed"
state to the
.I "awaiting integration"
state.
.TP 4n
Otherwise:
The change will remain in the
.I "being reviewed"
state.
It is expected that a future \f[CW]review_\%policy_\%command\fP execution will
satisfy the project criteria and exit zero.
.RE
.RE
.\" ------------------------------------------------------------------------
.PS
boxwid = 1
down
S1: box "being" "reviewed"
arrow " review" ljust " pass" ljust
S2: box "awaiting" "integration"
.\" mark time:
S3: box "being" "reviewed" with .w at S1.e+(0.5,0)
T7: spline -> from 2/3 then down 1/2 then right 5/6 \
then up 1.5 then left 5/6 then to 2/3
"review " rjust "pass " rjust at S3.e+(0.5,0)
.\" backtrack:
S4: box "being" "reviewed" with .w at S3.e+(1,0)
S5: box "awaiting" "review" with .s at S4.n+(0,0.5)
T8: spline -> from S4.e then right 1/2 then up 1 then to S5.e
"review " rjust "pass " rjust at S4.e+(0.5,0.5)
.PE
.\" ------------------------------------------------------------------------
.PP
It is possible to avoid the \fIbeing reviewed\fP state altogether by
setting the \fIdevelop_\%end_\%action\fP field of the project confituration
file to \fIgoto_\%awaiting_\%integration\fP.
.PP
If the project configuration file has specified the presence of
\f[CW]Signed-off-by:\fP lines, a suitable line containing the current
user's email address will be appended to the change description.
.PP
If you use one of the \-File, \-Edit or \-Reason options to add comments,
the file is to be in plain text, and it is recommended that you only use
a newline to terminate paragraphs (rather than to terminate lines) as
this will result in better formatting in the various listings.
.SS Notification
On successful completion of this command, the
\fIreview_\%pass_\%notify_\%command\fP field of the project
attributes is run, if set. See \fIaepattr\fP(5) and \fIaepa\fP(1)
for more information.
.SH OPTIONS
The following options are understood:
.\"
.\" 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
.\" .
.\"
.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.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1993, 1995, 1997, 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
.\" .
.\"
.TP 8n
.B -Edit
.br
.RS
Edit the attributes with a text editor, this is usually more convenient
than supplying a text file. The \fIVISUAL\fP and then \fPEDITOR\fP
environment variables are consulted for the name of the editor to use;
defaults to \fIvi\fP(1) if neither is set.
See the \fIvisual_\%command\fP and \fIeditor_\%command\fP fields in
\fIaeuconf\fP(1) for how to override this specifically for Aegis.
.PP
Warning: Aegis tries to be well behaved when
faced with errors, so the temporary file is left in your home directory
where you can edit it further and re-use it with a \fB\-file\fP option.
.PP
The \fB\-edit\fP option may not be used in the background, or when the
standard input is not a terminal.
.RE
.TP 8n
.B -Edit_BackGround
.br
Edit the attributes with a dumb text editor, this is most often desired
when edit commands are being piped into the editor via the standard input.
Only the \fPEDITOR\fP environment variable is consulted for the name of
the editor to use; it is a fatal error if it is not set.
See the \fIeditor_\%command\fP field in \fIaeuconf\fP(1) for how to
override this specifically for Aegis.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 1995, 2001, 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
.\" .
.\"
.TP 8n
\fB-File\fP \fIfilename\fP
.br
Take the attributes from the specified file.
The filename `-' is understood to mean the standard input.
.\"
.\" 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
.\" .
.\"
.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
.\" .
.\"
.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, 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
.\" .
.\"
.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.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 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
.\" .
.\"
.TP 8n
\fB\-REAson\fP \fItext\fP
This option may be used to attach a comment to the change history
generated by this command. You will need to use quotes to insulate the
spaces from the shell.
.\"
.\" aegis - project change supervisor
.\" Copyright (C) 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
.\" .
.\"
.TP 8n
\fB\-Signed_Off_By\fP
This option may be used to have a \f[CW]Signed-off-by:\fP line appended
to the change set description.
.TP 8n
\fB\-No_Signed_Off_By\fP
This option may be used to prevent a \f[CW]Signed-off-by:\fP line from
being appended to the change set description.
.\"
.\" 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
.\" .
.\"
.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
.\" .
.\"
.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
.\" .
.\"
.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
.\" .
.\"
.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 aerpass '\*(n) -rpass \e!* -v'
sh$ aerpass(){\*(n) -rpass "$@" -v}
.fi
.SH ERRORS
It is an error if
the change is not in the
.I "being reviewed"
state.
.br
It is an error if
the current user is not a reviewer of the project.
.br
Its is an error if
the current user developed the change and the project is configured to
disallow developers to review their own changes (default).
.\"
.\" 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
.\" .
.\"
.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 aecd (1)
change directory
.TP 8n
.IR aede (1)
complete development of a change
.TP 8n
.IR aedeu (1)
recall a change for further development
.TP 8n
.IR aeib (1)
begin integrating a change
.TP 8n
.IR aenrv (1)
add a reviewer to a project
.TP 8n
.IR aerfail (1)
fail review of a change
.TP 8n
.IR aerpu (1)
rescind a change review pass
.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
.\" .
.\"
.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