tkaer(1) tkaer(1) NNAAMMEE tkaer - GUI tool for reviewing Aegis change sets, using TCL/TK SSYYNNOOPPSSIISS ttkkaaeerr DDEESSCCRRIIPPTTIIOONN The _t_k_a_e_r command is used to provide an easy and convenient way to review Aegis change sets. It provides a front-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 _a_e_l(1) may be displayed by clicking on the ``Details'' button. MMOODDIIFFIIEEDD AANNDD MMOOVVEEDD FFIILLEESS _t_k_d_i_f_f 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 version.) Double-clicking button 1 on a file will show the differences between the change and the current branch baseline. Holding down button 3 will invoke a pop-up menu presenting the reviewer with a list of grandparent branches which also contain the file. This is particularly useful when rolling in branches. NNEEWW AANNDD RREEMMOOVVEEDD FFIILLEESS New files are viewed by opening a new _x_t_e_r_m and using _v_i (in read-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). AADDDDIITTIIOONNAALL FFEEAATTUURREESS FFOORR RREEVVIIEEWWEERRSS.. If the change is in the _b_e_i_n_g _r_e_v_i_e_w_e_d state, the reviewer may open the comments editor by clicking on the ``Comments'' 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 ``Finished'' button results in a dialog box which will allow the reviewer to pass or fail (via the _a_e_r_p_a_s_s(1) and _a_e_r_f_a_i_l(1) commands) the change. Alternatively, the reviewer may resume reviewing or quit, leaving the change state unmodified. If the change was not in the _b_e_i_n_g _r_e_v_i_e_w_e_d state, the ``Finished'' button simply causes _t_k_a_e_r to exit. CCOONNFFIIGGUURRIINNGG TTKKAAEERR _t_k_a_e_r may be customised by the .tkaer file. This file is created by _t_k_a_e_r 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 _t_k_a_e_r script using the _t_c_l ``source'' command. Each entry takes the form of a ``set'' statement which adds an item to the pref array. Items currently supported are: pprreeff((ddiiffff__ccoommmmaanndd)) This is the tool used to visually display the difference between a changes modified or moved file and the baseline version. pprreeff((vviieeww__ccoommmmaanndd)) This is the tool used to visually display a new file or a removed files, prior contents. The default is _v_i(1) pprreeff((vviieeww__eeddiitt__ffoonntt)) This is the font used by both the change details viewer and the review comments editor. Any available X11 font may be used. OOPPTTIIOONNSS --CChhaannggee _n_u_m_b_e_r This option may be used to specify a particular change within a project. When no --CChhaannggee option is specified, the _A_E_G_I_S___C_H_A_N_G_E environment 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 change 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 one change within a project, that is the default change number. Otherwise, it is an error. --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 environment 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 single project, the project name defaults to that project. Otherwise, it is an error. EEXXIITT SSTTAATTUUSS The _t_k_a_e_r command will exit with a status of 1 on any error. The _t_k_a_e_r 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. SSEEEE AALLSSOO _a_e_r_p_a_s_s(1) pass review of a change _a_e_r_f_a_i_l(1) fail review of a change _t_k_a_e_g_i_s(1) GUI interface for Aegis, using TCL/TK _t_k_d_i_f_f by John M. Klassa. TkDiff Home Page http://www.accurev.com/free/tkdiff AAUUTTHHOORR _t_k_a_e_r contributed by Scott Finneran Reference Manual Aegis 1