aegis -Review_Begin(1)					      General Commands Manual					    aegis -Review_Begin(1)

NAME

	aegis review begin - begin a change review

SYNOPSIS

	aegis -Review_Begin [ option...  ]
	aegis -Review_Begin -List [ option...  ]
	aegis -Review_Begin -Help

DESCRIPTION

	The aegis -Review_Begin command is used to notify aegis that you have begun to review a change.

	The change will be advanced from the awaiting review state to the being reviewed state.
	     +---------+
	     |awaiting |
	     + review  |
	     +----+----+
	 review   |review
	 begin	  +begin
	 undo+----+----+
	     | being   |
	     |reviewed |
	     +---------+

   Notification
	If the review_begin_notify_command has been set in the project attributes, this command will be run.  This is usually used to tell other
	reviewers that you have started review, and they need not.  See aepattr(5) and aepa(1) for more information.

	If used when the develop_end_action project attribute is set to goto_being_reviewed, then only the notification message is sent.

OPTIONS

	The following options are understood:

	-Change number
		This option may be used to specify a particular change within a project.  See aegis(1) for a complete description of this option.

	-Help
		This option may be used to obtain more information about how to use the aegis program.

	-List
		This option may be used to obtain a list of suitable subjects for this command.  The list may be more general than expected.

	-Project name
		This option may be used to select the project of interest.  When no -Project option is specified, the AEGIS_PROJECT environment
		variable is consulted.	If that does not exist, the user's $HOME/.aegisrc file is examined for a default project field (see aeu-
		conf(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.

	-REAson text
		This option may be used to attach a comment to the change history generated by this command.  You will need to use quotes to insu-
		late the spaces from the shell.

	-TERse
		This option may be used to cause listings to produce the bare minimum of information.  It is usually useful for shell scripts.

	-Verbose
		This option may be used to cause aegis to produce more output.	By default aegis only produces output on errors.  When used with
		the -List option this option causes column headings to be added.

	-Wait	This option may be used to require Aegis commands to wait for access locks, if they cannot be obtained immediately.  Defaults to
		the user's lock_wait_preference if not specified, see aeuconf(5) for more information.

	-No_Wait
		This option may be used to require Aegis commands to emit a fatal error if access locks cannot be obtained immediately.  Defaults
		to the user's lock_wait_preference if not specified, see aeuconf(5) for more information.

	See also aegis(1) for options common to all aegis commands.

	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.

	All options are case insensitive, you may type them in upper case or lower case or a combination of both, case is not important.

	For example: the arguments "-project, "-PROJ" and "-p" are all interpreted to mean the -Project option.  The argument "-prj" will not be
	understood, because consecutive optional characters were not supplied.

	Options and other command line arguments may be mixed arbitrarily on the command line, after the function selectors.

	The GNU long option names are understood.  Since all option names for aegis are long, this means ignoring the extra leading '-'.  The
	"--option=value" convention is also understood.

RECOMMENDED ALIAS

	The recommended alias for this command is
	csh%	alias aerb 'aegis -rb !* -v'
	sh$	aerb(){aegis -rb "$@" -v}

ERRORS

	It is an error if the change is not in the awaiting review state.
	It is an error if the current user is not a reviewer of the project.
	Its is an error if the current user developed the change and the project is configured to not permit developers to review their own
	changes (default).

EXIT STATUS

	The aegis command will exit with a status of 1 on any error.  The aegis command will only exit with a status of 0 if there are no errors.

ENVIRONMENT VARIABLES

	See aegis(1) for a list of environment variables which may affect this command.  See aepconf(5) for the project configuration file's
	project_specific field for how to set environment variables for all commands executed by Aegis.

SEE ALSO

	aecd(1) change directory

	aede(1) complete development of a change

	aedeu(1)
		recall a change for further development

	aerpass(1)
		pass review of a change

	aeib(1) begin integrating a change

	aenrv(1)
		add a reviewer to a project

	aerfail(1)
		fail review of a change

	aerpu(1)
		rescind a change review pass

	aeuconf(5)
		user configuration file format

COPYRIGHT

	aegis version 4.24.3.D001
	Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Peter
	Miller

	The aegis program comes with ABSOLUTELY NO WARRANTY; for details use the 'aegis -VERSion License' command.  This is free software and you
	are welcome to redistribute it under certain conditions; for details use the 'aegis -VERSion License' command.

AUTHOR

	Peter Miller   E-Mail:	 millerp@canb.auug.org.au
	//*		  WWW:	 http://www.canb.auug.org.au/~millerp/

Reference Manual						       Aegis						    aegis -Review_Begin(1)