aegis -Develop_Begin(1) General Commands Manual aegis -Develop_Begin(1) NNAAMMEE aegis develop begin - begin development of a change SSYYNNOOPPSSIISS aaeeggiiss --DDeevveelloopp__BBeeggiinn _c_h_a_n_g_e_-_n_u_m_b_e_r [ _o_p_t_i_o_n... ] aaeeggiiss --DDeevveelloopp__BBeeggiinn --LLiisstt [ _o_p_t_i_o_n... ] aaeeggiiss --DDeevveelloopp__BBeeggiinn --HHeellpp DDEESSCCRRIIPPTTIIOONN The _a_e_g_i_s _-_D_e_v_e_l_o_p___B_e_g_i_n command is used to commence development of a change. The development directory for the change will be created automati- cally; below the directory specified in the default_development_- directory field of _a_e_u_c_o_n_f(5), or if not set below the directory spec- ified in the default_development_directory field of _a_e_p_a_t_t_r(5), or if not set below the current user's home directory. It is rare to need to know the exact pathname of the development directory, as the _a_e_c_d(1) command can take you there at any time. Successful execution of this command will move the specified change from the _a_w_a_i_t_i_n_g _d_e_v_e_l_o_p_m_e_n_t state to the _b_e_i_n_g _d_e_v_e_l_o_p_e_d state. boxwid = 1 down S1: box "awaiting" "development" arrow " develop" ljust " begin" ljust S2: box "being" "developed" move to S2.w T1: spline -> left 0.75 then up 1 then to S1.w " develop" ljust " begin" ljust " undo" ljust at T1.c - (0.75,0) NNoottiiffiiccaattiioonn 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 specified. This is run after the aegis locks are released, so additional aegis commands may be run from here, if used with care. The symbolic links (see below) have _n_o_t yet been created. DDeevveellooppmmeenntt DDiirreeccttoorryy LLooccaattiioonn PPlleeaassee NNoottee:: Aegis also consults the underlying file system, to deter- mine its notion of maximum file size. Where the file system's maximum file size is less than _m_a_x_i_m_u_m___f_i_l_e_n_a_m_e___l_e_n_g_t_h, the filesystem wins. This can happen, for example, when you are using the Linux UMSDOS file system, or when you have an NFS mounted an ancient V7 filesystem. Setting _m_a_x_i_m_u_m___f_i_l_e_n_a_m_e___l_e_n_g_t_h to 255 in these cases does not alter the fact that the underlying file systems limits are far smaller (12 and 14, respectively). If your development directories (or your whole project) is on filesys- tems with filename limitations, or a portion of the heterogeneous builds take place in such an environment, it helps to tell Aegis what they are (using the project _c_o_n_f_i_g file's fields) so that you don't run into the situation where the project builds on the more permissive environments, but fails with mysterious errors in the more limited environments. If your development directories are routinely on a Linux UMSDOS filesystem, you would probably be better off setting _d_o_s___f_i_l_e_- _n_a_m_e___r_e_q_u_i_r_e_d _= _t_r_u_e, and also changing the _d_e_v_e_l_o_p_m_e_n_t___d_i_r_e_c_t_o_r_y___t_e_m_- _p_l_a_t_e field. Heterogeneous development with various Windows environ- ments may also require this. AADDMMIINNIISSTTRRAATTOORR OOVVEERRRRIIDDEE It is possible for project administrators to use the --UUsseerr option to force a developer to start developing a change. Some sites prefer to work this way. Note that developers still have the ability to use the _a_e_d_b_u(1) command. Warning: capricious use of this command will rapidly alienate develop- ers. The defaulting rules, particularly for the change number, depend on aegis and the developer agreeing on what the developer is currently working on. The _f_o_r_c_e_d___d_e_v_e_l_o_p___b_e_g_i_n___n_o_t_i_f_y___c_o_m_m_a_n_d project attribute (see _a_e_p_a_t_t_r(5) for more information) will be run when an administrator uses the --UUsseerr option, in an attempt to minimize the surprises for developers. A suitable command is forced_develop_begin_notify_command = "$datadir/db_forced.sh $p $c $developer"; This command will send e-mail to the developer, informing her that the change has been assigned to her. 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). 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. --DDIIRReeccttoorryy _p_a_t_h This option may be used to specify which directory is to be used. It is an error if the current user does not have appro- priate permissions to create the directory path given. This must be an absolute path. Caution: If you are using an automounter do not use `pwd` to make an absolute path, it usually gives the wrong answer. --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. --UUsseerr _n_a_m_e This option is used to specify the user who is to develop the change. This option may only be used by a project administra- tor. --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 aedb 'aegis -db \!* -v' sh$ aedb(){aegis -db "$@" -v} EERRRROORRSS It is an error if the change does not exist. It is an error if the change is not in the _a_w_a_i_t_i_n_g _d_e_v_e_l_o_p_m_e_n_t state. It is an error if the current user is not a developer of the specified project. 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_b(1) build a change _a_e_c_d(1) change directory _a_e_c_p(1) copy files into a change _a_e_d(1) find differences between a change and the baseline _a_e_d_b_u(1) undo the effects of aedb _a_e_d_e(1) complete development of a change _a_e_m_v(1) rename a file as part of a change _a_e_n_c(1) add a new change to a project _a_e_n_d(1) add a new developer to a project _a_e_n_f(1) add new files to a change _a_e_n_t(1) add a new test to a change _a_e_p_a(1) modify the attributes of a project _a_e_r_m(1) add files to be deleted to a change _a_e_t(1) run tests _a_e_p_a_t_t_r(5) project attributes file format _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 -Develop_Begin(1)