aegis -Build(1) aegis -Build(1) NNAAMMEE aegis -Build - build a change SSYYNNOOPPSSIISS aaeeggiiss --BBuuiilldd [ _o_p_t_i_o_n... ][ _f_i_l_e_n_a_m_e... ] aaeeggiiss --BBuuiilldd --LLiisstt [ _o_p_t_i_o_n... ] aaeeggiiss --BBuuiilldd --HHeellpp DDEESSCCRRIIPPTTIIOONN The _a_e_g_i_s _-_B_u_i_l_d command is used to build a project. The project configuration file is consulted for the appropriate build command, and that command is executed (see _a_e_p_c_o_n_f(5) for more information.) Output of the command is automatically logged to the _a_e_g_i_s_._l_o_g file at the root of the development directory tree. The build command will be executed with its current directory being the root of the development directory, irrespective of there the _a_e_g_i_s _-_B_u_i_l_d command was executed. If the change is in the _b_e_i_n_g _i_n_t_e_g_r_a_t_e_d state, references to the development directory, above, should be read as the integration directory. Integration build commands are executed with the user and group set to the project's owning user and group. That is, it is not necessary for an integrator to log in as someone else, the project account for instance, in order to do an integration. PPrroocceessss SSiiddee EEffffeeccttss This command will cancel any test registrations, because building the project logically invalidates them. If the project _c_o_n_f_i_g file was deleted, any diff registration will also be canceled. PPAARRTTIIAALL BBUUIILLDD If files are named on the command line, these files are appended to the build command. This is known as a partial build. Partial builds are not legal in the _b_e_i_n_g _i_n_t_e_g_r_a_t_e_d state, but can often be useful in the _b_e_i_n_g _d_e_v_e_l_o_p_e_d state. Partial builds are not recorded in the change status, because builds are decoupled from aegis it is not possible for aegis to know if any set of partial builds is equivalent to a full build. Warning: no change state lock is taken for a partial build, only a baseline read lock. 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. 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 _a_e_g_i_s. (It becomes multi- level when aegis' branching functionality is used.) To allow these tools to be used, _a_e_g_i_s 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 Two boolean fields of the project _c_o_n_f_i_g file control the behavior of this feature. They are the _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 and _r_e_m_o_v_e___s_y_m_l_i_n_k_s___a_f_t_e_r___b_u_i_l_d fields. See _a_e_p_c_o_n_f(5) for more information. If both fields are set to _t_r_u_e, the user never sees the symbolic links, because they are added purely for the benefit of the dependency maintenance tool during the execution of the _a_e_b(1) command. If only the _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 field is set to _t_r_u_e (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 development 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.) 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 _c_o_n_f_i_g 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 relevant 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 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 preference and the verify symbolic links. There are two command line options which modify _a_e_b(1) behavior further: the ----VVeerriiffyy__SSyymmbboolliicc__LLiinnkkss option says to verify the symbolic links; and the ----AAssssuummee__SSyymmbboolliicc__-- LLiinnkkss option says to assume the symbolic links are up-to- date. In each case the option over-rides the default and the user preference. TTHHEE BBAASSEELLIINNEE LLOOCCKK The baseline lock is used to ensure that the baseline remains in a consistent state for the duration of commands which need to read the contents of files in the baseline. The commands which require the baseline to be consistent (these include the _a_e_b(1), _a_e_c_p(1) and _a_e_d(1) commands) take a baseline _r_e_a_d lock. This is a non-exclusive lock, so the concurrent development of changes is not hindered. The command which modifies the baseline, _a_e_i_p_a_s_s(1), takes a baseline _w_r_i_t_e lock. This is an exclusive lock, forcing _a_e_i_p_a_s_s(1) to block until there are no active baseline read locks. It is possible that one of the above development commands will block until an in-progress _a_e_g_i_s _-_I_n_t_e_g_r_a_t_e___P_A_S_S completes. This is usually of short duration while the project history is updated. The delay is essential so that these commands receive a consistent view of the baseline. No other integration command will cause the above development commands to block. When aegis' branch functionality is in use, a read (non- exclusive) lock is taken on the branch baseline and also each of the "parent" baselines. However, a baseline write (exclusive) lock is only taken on the branch baseline; the "parent" baselines are only read (non-exclusive) locked. MMEETTRRIICCSS Aegis is capable of recording metrics as part of the file attributes of a change. This allows various properties of files to be recorded for later trend analysis, or other uses. The specific metrics are not dictated by Aegis. It is expected that the integration build will create a metrics file for each of the source files the change. These metrics files must be in the format specified by _a_e_m_e_t_r_i_c_s(5). The name of the metrics file defaults to ``_f_i_l_e_n_a_m_e,,SS'', however it may be varied, by setting the _m_e_t_r_i_c_s___- _f_i_l_e_n_a_m_e___p_a_t_t_e_r_n field of the project _c_o_n_f_i_g file. See _a_e_p_c_o_n_f(5) for more information. If such a metrics file exists, for each source file in a change, it will be read and remembered at integrate pass time. If it does not exist, Aegis assumes there are no relevant metrics for that file, and proceeds silently; it is not an error. OOPPTTIIOONNSS The following options are understood: _n_a_m_e==_v_a_l_u_e Command line arguments of this form are assumed to be variable assignments for the build tool. They are passed through unchanged. They imply a partial build. --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. --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. --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. --VVeerriiffyy__SSyymmbboolliicc__LLiinnkkss This option may be used to request a scan for up- to-date symbolic links before and after the build. This is the default. See also the ``symbolic_links_preference'' field of _a_e_u_c_o_n_f(5). This option is not meaningful if symbolic links are not being used. --AAssssuummee__SSyymmbboolliicc__LLiinnkkss This option may be used to request no scan for up- to-date symbolic links before and after the build, this is useful when you have just done a build and you know they are already up-to-date. See also the ``symbolic_links_preference'' field of _a_e_u_c_o_n_f(5). This option is not meaningful if symbolic links are not being used. --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 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 aeb 'aegis -b \!* -v' sh$ aeb(){aegis -b "$@" -v} EERRRROORRSS It is an error if the change is not assigned to the current user. It is an error if the change is not in one of the _b_e_i_n_g _d_e_v_e_l_o_p_e_d or _b_e_i_n_g _i_n_t_e_g_r_a_t_e_d states. It is an error if a partial build is requested and the change is in the _b_e_i_n_g _i_n_t_e_g_r_a_t_e_d state. 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_d_b(1) begin development of a change _a_e_c_p(1) file copy also takes a baseline read lock (non- exclusive) _a_e_i_b(1) begin integration of a change _a_e_i_p_a_s_s(1) integrate pass takes a baseline write lock (exclusive) _a_e_t(1) run tests _a_e_m_e_t_r_i_c_s(5) metrics values file format _a_e_p_c_o_n_f(5) project configuration file format _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