aegis -ReMove_file(1) aegis -ReMove_file(1) NNAAMMEE aegis -ReMove_file - add files to be deleted to a change SSYYNNOOPPSSIISS aaeeggiiss --RReeMMoovvee__ffiillee _f_i_l_e_-_n_a_m_e... [ _o_p_t_i_o_n... ] aaeeggiiss --RReeMMoovvee__ffiillee --LLiisstt [ _o_p_t_i_o_n... ] aaeeggiiss --RReeMMoovvee__ffiillee --HHeellpp DDEESSCCRRIIPPTTIIOONN The _a_e_g_i_s _-_R_e_M_o_v_e___f_i_l_e command is used to add files to be deleted to a change. The file will be added to the list of files in the change, and will be removed from the baseline at integration time. This command may be used to remove tests, not just source files. Tests are treated just like any other source file, and are subject to the same process. A file will be created in the development directory containing 1KB of random text. The random text is sufficiently revolting that most compilers will give error messages, should the file be referenced accidentally. This is often very helpful when removing include files. You may specify a directory name to remove all files in the named directory tree. It is an error if there are no relevant files. FFiillee NNaammee IInntteerrpprreettaattiioonn The aegis program will attempt to determine the project file names from the file names given on the command line. All file names are stored within aegis projects as relative to the root of the baseline directory tree. The development directory and the integration directory are shadows of this baseline directory, and so these relative names apply here, too. Files named on the command line are first converted to absolute paths if necessary. They are then compared with the baseline path, the development directory path, and the integration directory path, to determine a baseline-relative name. It is an error if the file named is outside one of these directory trees. The --BBAAssee__RREEllaattiivvee option may be used to cause relative filenames to be interpreted as relative to the baseline path; absolute filenames will still be compared with the various paths in order to determine a baseline-relative name. The _r_e_l_a_t_i_v_e___f_i_l_e_n_a_m_e___p_r_e_f_e_r_e_n_c_e in the user configuration file may be used to modify this default behavior. See _a_e_u_c_o_n_f(5) for more information. PPrroocceessss SSiiddee EEffffeeccttss This command will cancel any build or test registrations, because adding a file logically invalidates them. When the change files are listed (_a_e_g_i_s _-_L_i_s_t _C_h_a_n_g_e___F_i_l_e_s _-_T_E_R_s_e) the removed files will not appear in the terse listing. Similarly, when the project files are listed with an explicit change number (_a_e_g_i_s _-_L_i_s_t _P_r_o_j_e_c_t___F_i_l_e_s _-_T_E_R_s_e _-_C_h_a_n_g_e N) none of the change's files, including the the removed files, will not appear in the terse listing. These two features are very helpful when calling aegis from within a DMT to generate the list of source files. WWHHIITTEEOOUUTT Aegis provides you with what is often called a ``view path'' which indicates to development tools (compilers, build systems, _e_t_c) look first in the development directory, then in the branch baseline, and so on up to the trunk baseline. The problem with view paths is that in order to remove files, you need some kind of "whiteout" to say ``stop looking, it's been removed.'' When you user the _a_e_r_m(1) or _a_e_m_v(1) commands, this means "add information to this change which will remove the file from the baseline when this change is integrated". _I_._e_. while the change is in the _b_e_i_n_g _d_e_v_e_l_o_p_e_d state, the file is only "removed" in the development directory - it's still present in the baseline, and will be until the change is successfully integrated. When you use the _a_e_r_m(1) or _a_e_m_v(1) commands, Aegis will create a 1K file to act as the whiteout. It's contents are rather ugly so that if you compile or include the "removed" file accidentally, you get a fatal error. This will remind you to remove obsolete references. When the change in integrated, the removed file is _n_o_t copied/linked from the baseline to the integration directory, and is _n_o_t copied from the development directory. At this time it is physically gone (no whiteout). It is assumed that because of the error inducing whiteout all old references were found and fixed while the change was in the _b_e_i_n_g _d_e_v_e_l_o_p_e_d state. FFiillee MMaanniiffeessttss When generating list of files to be compiled or linked, it is important that the file manifest be generated from information known by Aegis, rather than from the file system. This is for several reasons: (a) Aegis knows exactly what (source) files are where, whereas everything else is inferring Aegis' knowledge; and (b) looking in the file system is hard when the view path is longer that 2 directories (and Aegis' branching method can make it arbitrarily long); and (c) The whiteout files, and anything else left ``lying around'', will confuse any method which interrogates the file system. The easiest way to use Aegis' file knowledge is with something like an _a_w_k(1) script processing the Aegis file lists. For example, you can do this with _m_a_k_e(1) as follows: # generate the file manifest manifest.make.inc: manifest.make.awk ( aegis -l cf -ter ; aegis -l pf -ter ) | awk -f manifest.make.awk > manifest.make.inc # now include the file manifest include manifest.make.inc Note: this would be inefficient of you did it once per directory, but there is nothing stopping you writing numerous assignments into the _m_a_n_i_f_e_s_t_._m_a_k_e_._i_n_c file, all in one pass. It is possible to do the same thing with Aegis' report generator (see _a_e_r(1) for more information), but this is more involved than the _a_w_k(1) script. However, with the information "straight from the horse's mouth" as it were, it can also be much smarter. This file manifest would become out-of-date without an interlock to Aegis' file operations commands. By using the _p_r_o_j_e_c_t_-_f_i_l_e___c_o_m_m_a_n_d and _c_h_a_n_g_e___f_i_l_e___c_o_m_m_a_n_d fields of the project _c_o_n_f_i_g file (see _a_e_p_c_o_n_f(5) for more information), you can delete this file at strategic times. /* run when the change file manifest is altered */ change_file_command = "rm -f manifest.make.inc"; /* run when the project file manifest is altered */ project_file_command = "rm -f manifest.make.inc"; The new file manifest will thus be re-built during the next _a_e_b(1) command. OOppttiioonnss aanndd PPrreeffeerreenncceess There is a --NNoo--WWhhiitteeOOuutt option, which may be used to suppress whiteout files when you use the _a_e_r_m(1) and _a_e_m_v(1) commands. There is a corresponding --WWhhiitteeOOuutt option, which is usually the default. There is a _w_h_i_t_e_o_u_t___p_r_e_f_e_r_e_n_c_e field in the user preferences file (see _a_e_u_c_o_n_f(5) for more information) if you want to set this option more permanently. WWhhiitteeoouutt FFiillee TTeemmppllaatteess The _w_h_i_t_e_o_u_t___t_e_m_p_l_a_t_e field of the project _c_o_n_f_i_g file may be used to produce language-specific error files. If no whiteout template entry matches, a very ugly 1KB file will be produced - it should induce compiler errors for just about any language. If you want a more human-readable error message, entries such as whiteout_template = [ { pattern = [ "*.[ch]" ]; body = "#error This file has been removed."; } ]; can be very effective (this example assumes _g_c_c(1) is being used). If it is essential that _n_o whiteout file be produced, say for C source files, you could use a whiteout template such as whiteout_template = [ { pattern = [ "*.c" ]; } ]; because an absent _b_o_d_y sub-field means generate no whiteout file at all. You may have more than one whiteout template entry, but note that the order of the entries is important. The first entry which matches will be used. OOPPTTIIOONNSS The following options are understood: --BBAAssee__RREEllaattiivvee This option may be used to cause relative filenames to be considered relative to the base of the source tree. See _a_e_u_c_o_n_f(5) for the corresponding user preference. --CCUUrrrreenntt__RREEllaattiivvee This option may be used to cause relative filenames to be considered relative to the current directory. This is usually the default. See _a_e_u_c_o_n_f(5) for the corresponding user preference. --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. --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. --NNoott__LLooggggiinngg This option may be used to disable the automatic logging of output and errors to a file. This is often useful when several aegis commands are combined in a shell script. --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. --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. --WWhhiitteeOOuutt This option may be used to request that deleted files be replaced by a ``whiteout'' file in the development directory. The idea is that compiling such a file will result in a fatal error, in order that all references may be found. This is usually the default. --NNoo__WWhhiitteeOOuutt This option may be used to request that no ``whiteout'' file be placed in the development directory. 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 interpreted 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 aerm 'aegis -rm \!* -v' sh$ aerm(){aegis -rm "$@" -v} EERRRROORRSS It is an error if the change is not in the _b_e_i_n_g _d_e_v_e_l_o_p_e_d state. It is an error if the change is not assigned to the current user. It is an error if the file does not exist in the baseline. It is an error if the file is already part of the change. 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. SSEEEE AALLSSOO _a_e_c_p(1) copy files into a change _a_e_d_b(1) begin development of a change _a_e_m_v(1) rename a file as part of a change _a_e_n_f(1) add files to be created to a change _a_e_r_m_u(1) remove files to be deleted from a change _a_e_u_c_o_n_f(5) user configuration file format CCOOPPYYRRIIGGHHTT aegis version .C001 Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001 Peter Miller; All rights reserved. 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: millerp@canb.auug.org.au /\/\* WWW: http://www.canb.auug.org.au/~millerp/ Reference Manual Aegis 1