aegis -Review_Begin(1) General Commands Manual aegis -Review_Begin(1) NNAAMMEE aegis review begin - begin a change review SSYYNNOOPPSSIISS aaeeggiiss --RReevviieeww__BBeeggiinn [ _o_p_t_i_o_n... ] aaeeggiiss --RReevviieeww__BBeeggiinn --LLiisstt [ _o_p_t_i_o_n... ] aaeeggiiss --RReevviieeww__BBeeggiinn --HHeellpp DDEESSCCRRIIPPTTIIOONN The _a_e_g_i_s _-_R_e_v_i_e_w___B_e_g_i_n command is used to notify aegis that you have begun to review a change. The change will be advanced from the _a_w_a_i_t_i_n_g _r_e_v_i_e_w state to the _b_e_i_n_g _r_e_v_i_e_w_e_d state. boxwid = 1 down S1: box "awaiting" "review" arrow " review" ljust " begin" ljust S2: box "being" "reviewed" move to S2.w T1: spline left 0.5 then up 1 then to S1.w -> " review" ljust " begin" ljust " undo" ljust at T1.c-(0.5,0) NNoottiiffiiccaattiioonn If the _r_e_v_i_e_w___b_e_g_i_n___n_o_t_i_f_y___c_o_m_m_a_n_d 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 _a_e_p_a_t_t_r(5) and _a_e_p_a(1) for more information. If used when the _d_e_v_e_l_o_p___e_n_d___a_c_t_i_o_n project attribute is set to _g_o_t_o___b_e_i_n_g___r_e_v_i_e_w_e_d, then only the notification message is sent. OOPPTTIIOONNSS The following options are understood: --CChhaannggee _n_u_m_b_e_r This option may be used to specify a particular change within a project. See _a_e_g_i_s(1) for a complete description of this option. --HHeellpp This option may be used to obtain more information about how to use the _a_e_g_i_s program. --LLiisstt This option may be used to obtain a list of suitable subjects for this command. The list may be more general than expected. --PPrroojjeecctt _n_a_m_e This option may be used to select the project of interest. When no --PPrroojjeecctt option is specified, the _A_E_G_I_S___P_R_O_J_E_C_T envi- ronment variable is consulted. If that does not exist, the user's _$_H_O_M_E_/_._a_e_g_i_s_r_c file is examined for a default project field (see _a_e_u_c_o_n_f(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. --RREEAAssoonn _t_e_x_t This option may be used to attach a comment to the change his- tory generated by this command. You will need to use quotes to insulate the spaces from the shell. --TTEERRssee This option may be used to cause listings to produce the bare minimum of information. It is usually useful for shell scripts. --VVeerrbboossee This option may be used to cause aegis to produce more output. By default aegis only produces output on errors. When used with the --LLiisstt option this option causes column headings to be added. --WWaaiitt 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 _l_o_c_k___w_a_i_t___p_r_e_f_e_r_e_n_c_e if not specified, see _a_e_u_c_o_n_f(5) for more information. --NNoo__WWaaiitt 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 _l_o_c_k___w_a_i_t___p_r_e_f_e_r_e_n_c_e if not specified, see _a_e_u_c_o_n_f(5) for more information. See also _a_e_g_i_s(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 inter- preted to mean the --PPrroojjeecctt 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 _a_e_g_i_s are long, this means ignoring the extra leading '-'. The "----_o_p_t_i_o_n==_v_a_l_u_e" convention is also understood. RREECCOOMMMMEENNDDEEDD AALLIIAASS The recommended alias for this command is csh% alias aerb 'aegis -rb \!* -v' sh$ aerb(){aegis -rb "$@" -v} EERRRROORRSS It is an error if the change is not in the _a_w_a_i_t_i_n_g _r_e_v_i_e_w 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). EEXXIITT SSTTAATTUUSS The _a_e_g_i_s command will exit with a status of 1 on any error. The _a_e_g_i_s command will only exit with a status of 0 if there are no errors. EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS See _a_e_g_i_s(1) for a list of environment variables which may affect this command. See _a_e_p_c_o_n_f(5) for the project configuration file's _p_r_o_j_e_c_t___s_p_e_c_i_f_i_c field for how to set environment variables for all commands executed by Aegis. SSEEEE AALLSSOO _a_e_c_d(1) change directory _a_e_d_e(1) complete development of a change _a_e_d_e_u(1) recall a change for further development _a_e_r_p_a_s_s(1) pass review of a change _a_e_i_b(1) begin integrating a change _a_e_n_r_v(1) add a reviewer to a project _a_e_r_f_a_i_l(1) fail review of a change _a_e_r_p_u(1) rescind a change review pass _a_e_u_c_o_n_f(5) user configuration file format CCOOPPYYRRIIGGHHTT aegis version 4.25.D611 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Peter Miller The aegis program comes with ABSOLUTELY NO WARRANTY; for details use the '_a_e_g_i_s _-_V_E_R_S_i_o_n _L_i_c_e_n_s_e' command. This is free software and you are welcome to redistribute it under certain conditions; for details use the '_a_e_g_i_s _-_V_E_R_S_i_o_n _L_i_c_e_n_s_e' command. AAUUTTHHOORR Peter Miller E-Mail: pmiller@opensource.org.au /\/\* WWW: http://miller.emu.id.au/pmiller/ Reference Manual Aegis aegis -Review_Begin(1)