Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
aegis -Review_FAIL(1)	    General Commands Manual	 aegis -Review_FAIL(1)

NAME
	aegis review fail - fail a change review

SYNOPSIS
	aegis -Review_FAIL -File reason-file [ option...  ]
	aegis -Review_FAIL -REAson 'reason-text' [ option...  ]
	aegis -Review_FAIL -Edit [ option...  ]
	aegis -Review_FAIL -List [ option...  ]
	aegis -Review_FAIL -Help

DESCRIPTION
	The  aegis  -Review_FAIL command is used to inform aegis that a	change
	has failed review.

	The change will	be returned from the being reviewed state to the being
	developed state.  The change will cease	to be assigned to the  current
	user, and will be reassigned to	the originating	developer.  boxwid = 1
	down  S2:  box "being" "developed" arrow " develop" ljust " end" ljust
	box "awaiting" "review"	arrow "	review"	ljust "	begin" ljust  S3:  box
	"being"	"reviewed"

	move  to S3.e T5: spline right 0.5 then	up 2 then to S2.e -> "review "
	rjust "fail " rjust at T5.c + (0.5,0)

	The developer will be  notified	 by  mail.   See  the  review_fail_no-
	tify_command in	aepattr(5) for more information.

	The  reason-file  will	contain	 a  description	 of why	the change was
	failed.	 The file is in	plain text.  It	is recommended that  you  only
	use  newline to	terminate paragraphs, (rather than to terminate	lines)
	as this	will result in better formatting in the	various	listings.

   Notification
	On successful completion of  this  command,  the  review_fail_notify_-
	command	 field	of  the	 project  attributes  is  run,	if  set.   See
	aepattr(5) and aepa(1) for more	information.

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.

	-Edit
		Edit the attributes with a text	editor,	this is	 usually  more
		convenient  than  supplying  a text file.  The VISUAL and then
		EDITOR environment variables are consulted for the name	of the
		editor to use; defaults	to vi(1) if neither is set.   See  the
		visual_command and editor_command fields in aeuconf(1) for how
		to override this specifically for Aegis.

		Warning:  Aegis	 tries	to be well behaved when	faced with er-
		rors, so the temporary file is left  in	 your  home  directory
		where  you  can	edit it	further	and re-use it with a -file op-
		tion.

		The -edit option may not be used in the	 background,  or  when
		the standard input is not a terminal.

	-Edit_BackGround
		Edit  the attributes with a dumb text editor, this is most of-
		ten desired when edit commands are being piped into the	editor
		via the	standard input.	 Only the EDITOR environment  variable
		is  consulted for the name of the editor to use; it is a fatal
		error if it is not set.	 See the editor_command	field in  aeu-
		conf(1)	for how	to override this specifically for Aegis.

	-File filename
		Take the attributes from the specified file.  The filename `-'
		is understood to mean the standard input.

	-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	 envi-
		ronment	 variable  is  consulted.  If that does	not exist, the
		user's $HOME/.aegisrc file is examined for a  default  project
		field (see aeuconf(5) for more information).  If that does not
		exist,	when the user is only working on changes within	a sin-
		gle project, the project name defaults to that project.	  Oth-
		erwise,	it is an error.

	-REAson	text
		This  option  may be used to provide the failure reason	on the
		command	line, rather than in a file.  You  will	 need  to  use
		quotes to insulate 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.  De-
		faults 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 op-
	tional.	 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	inter-
	preted 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	"--op-
	tion=value" convention is also understood.

RECOMMENDED ALIAS
	The recommended	alias for this command is
	csh%	alias aerfail 'aegis -rfail \!*	-v'
	sh$	aerfail(){aegis	-rfail "$@" -v}

ERRORS
	It is an error if the change is	not in the being reviewed state.
	It is an error if the current user is not a reviewer for the project.
	It  is	an  error  if  the  current  user developed the	change and the
	project	is configured to  disallow  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  er-
	rors.

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

	aenrv(1)
		add a reviewer to a project

	aerpass(1)
		pass review of a change

	aeuconf(5)
		user configuration file	format

COPYRIGHT
	aegis version 4.25.D510
	Copyright  (C)	1991,  1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
	2000, 2001, 2002, 2003,	2004, 2005,  2006,  2007,  2008,  2009,	 2010,
	2011, 2012 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:	 pmiller@opensource.org.au
	/\/\*		  WWW:	 http://miller.emu.id.au/pmiller/

Reference Manual		     Aegis		 aegis -Review_FAIL(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=aerfail&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help