aegis -CLEan(1) aegis -CLEan(1) NNAAMMEE aegis clEan - clean files from development directory SSYYNNOOPPSSIISS aaeeggiiss --CCLLEEaann [ _o_p_t_i_o_n... ] aaeeggiiss --CCLLEEaann --HHeellpp aaeeggiiss --VVEERRSSiioonn DDEESSCCRRIIPPTTIIOONN The _a_e_g_i_s _-_C_L_E_a_n command is used to remove all files which are not change source files from a development directory. This can be used to obtain a "clean" development directory before a final build, to ensure that a change is ready to end development. A new build will be required. This command is only allowed in the "_b_e_i_n_g _d_e_v_e_l_o_p_e_d" state, and only the change's developer may issue it. It may not be applied to branches. All symbolic links will be removed from the development directory, even if _r_e_m_o_v_e___s_y_m_l_i_n_k_s___a_f_t_e_r___b_u_i_l_d _= _f_a_l_s_e in the project _c_o_n_f_i_g file. The symbolic links will be re-installed, if _c_r_e_a_t_e___s_y_m_l_i_n_k_s___- _b_e_f_o_r_e___b_u_i_l_d _= _t_r_u_e. This is to ensure that the symlinks are accu- rate, and that unnecessary ones are removed. All special device files, pipes and sockets will be removed. These files cannot be source files, and it is expected that the following build will restore them. All derived files created by previous builds of the change will be removed. It is expected that the following build will recreate them. Any temporary files you may have created in the development directory will also be removed. The _d_e_v_e_l_o_p___b_e_g_i_n___c_o_m_m_a_n_d in the project configuration file (see _a_e_p_- _c_o_n_f(5) for more information) will be run, if there is one. The _c_h_a_n_g_e___f_i_l_e___c_o_m_m_a_n_d will be run, if there is one. The _p_r_o_j_e_c_t___f_i_l_e___c_o_m_m_a_n_d will be run, if there is one. You will be warned if any of the files are out-of-date and need to be merged. You will be warned if any files need to be differenced. SSYYMMBBOOLLIICC LLIINNKKSS Many dependency maintenance tools, and indeed some compilers, have little or no support for include file search paths, and thus for the concept of the two-level directory hierarchy employed by Aegis. (It becomes multi-level when Aegis' branching functionality is used.) To allow these tools to be used, Aegis provides the ability to maintain a set of symbolic links between the development directory of a change and the baseline of a project, so it appears to these tools that all of the project's files are present in the development directory. PPrroojjeecctt CCoonnffiigguurraattiioonn The _d_e_v_e_l_o_p_m_e_n_t___d_i_r_e_c_t_o_r_y___s_t_y_l_e field of the project configuration file controls the appearance of the development directory. See _a_e_p_- _c_o_n_f(5) for more information. By using a setting such as development_directory_style = { source_file_symlink = true; during_build_only = true; }; the user never sees the symbolic links, because they are added purely for the benefit of the dependency maintenance tool during the execu- tion of the _a_e_b(1) command. By using a setting such as development_directory_style = { source_file_symlink = true; }; (the other will default to false) the symbolic links will be created at develop begin time (see _a_e_d_b(1) for more information) and also maintained by each _a_e_b(1) invocation. Note that the symbolic links are only maintained at these times, so project integrations during the course of editing change sourec files may leave the symbolic links in an inconsistent state until the next build. When files are copied from the baseline into a change, using the _a_e_c_p(1) command, the symbolic link pointing into the baseline, if any, will be removed before the file is copied. NNoottee:: Using this functionality in either form has implications for how the rules file of the dependency maintenance tool is written. Rules must _r_e_m_o_v_e their targets before creating them (usually with an _r_m _-_f command) if you use any of the link sub-fields (both hard links and symbolic links). This is to avoid attempting to write the result on the symbolic link, which will point at a read-only file in the project baseline. This is similar to the same requirement for using the _l_i_n_k___i_n_t_e_g_r_a_t_i_o_n___d_i_r_e_c_t_o_r_y field of the project configuration file. UUsseerr CCoonnffiigguurraattiioonn There is a _s_y_m_b_o_l_i_c___l_i_n_k___p_r_e_f_e_r_e_n_c_e field in the user configuration file (see _a_e_u_c_o_n_f(5) for more information). This controls whether _a_e_b(1) will verify the symbolic links before the build (default) or whether it will assume they are up-to-date. (This field is only rele- vant if _d_e_v_e_l_o_p_m_e_n_t___d_i_r_e_c_t_o_r_y_____s_t_y_l_e_._s_o_u_r_c_e___f_i_l_e___s_y_m_l_i_n_k is true.) For medium-to-large projects, verifying the symbolic links can take as long as the build itself. Assuming the symbolic links are up-to-date can be a large time-saving for these projects. It may be advisable to review your choice of DMT in such a situation. The _a_e_d_b(1) command ddooeess nnoott consult this preference. Thus, in most situations, the symbolic links will be up-to-date when the build is performed. The only Aegis function which may result in the symbolic links becoming out-of-date is the integration of another change, as this may alter the presence or absence of files in the baseline. In this situation, the default _a_e_b(1) action is to ignore the user pref- erence and the verify symbolic links. There are two command line options which modify _a_e_b(1) behavior fur- ther: the --VVeerriiffyy--SSyymmbboolliicc--LLiinnkkss option says to verify the symbolic links; and the --AAssssuummee--SSyymmbboolliicc--LLiinnkkss option says to assume the sym- bolic links are up-to-date. In each case the option over-rides the default and the user preference. It is possible to obtain behaviour similar to Tom Lord'a Arch by using a setting such as: development_directory_style = { source_file_link = true; source_file_symlink = true; }; It is possible to obtain behaviour similar to CVS by using a setting such as: development_directory_style = { source_file_copy = true; }; There are many more possible configurations of the _d_e_v_e_l_o_p_m_e_n_t___- _d_i_r_e_c_t_o_r_y___s_t_y_l_e, usually with helpful build side-effects. See _a_e_p_- _c_o_n_f(1) and the _D_e_p_e_n_e_d_e_n_c_y _M_a_i_n_t_e_n_a_n_c_e _T_o_o_l chapter of the User Guide for more information. The symbolic link command line options and preferences apply equally to hard links and file copies (the names have historical origins). NNoottiiffiiccaattiioonn The notification commands that would be run by the _a_e_c_p(1), _a_e_d_b(1), _a_e_n_f(1), _a_e_n_t(1) and _a_e_r_m(1) commands are run, as appropriate. The _p_r_o_j_e_c_t___f_i_l_e___c_o_m_m_a_n_d is also run, if set. See _a_e_p_c_o_n_f(5) for more information. 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. --NNoott__LLooggggiinngg This option may be used to disable the automatic logging of output and errors to a file. This is often useful when sev- eral aegis commands are combined in a shell script. --TTOOuucchh This option may be used to request that each change source file have its last-modified time-stamp be updated to the cur- rent time. This is the default. Derived files and other non- source file are left alone. --NNoo__TTOOuucchh This option may be used to request that the last-modified time-stamp of each source file be left unmodified. --MMIINNIIMMuumm This option may be used to request a minimum set of symbolic links, when the _c_r_e_a_t_e___s_y_m_l_i_n_k_s___t_o___b_a_s_e_l_i_n_e functions are being used. This is useful if you want to simulate something like _a_e_i_b _-_m_i_n_i_m_u_m in the development directory. This option is not meaningful if symbolic links are not being used. This option also says not to remove normal files which occlude project source files. This is a common technique used to tem- porarily over-ride project source files. The "_a_e_c_p _-_r_e_a_d_- _o_n_l_y_" _c_o_m_m_a_n_d _w_o_u_l_d _h_a_v_e _b_e_e_n _m_o_r_e _a_p_p_r_o_p_r_i_a_t_e_. --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. --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. 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. 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 -CLEan(1)