aegis -Change_Attributes(1) General Commands Manualaegis -Change_Attributes(1) NNAAMMEE aegis change attributes - modify the attributes of a change SSYYNNOOPPSSIISS aaeeggiiss --CChhaannggee__AAttttrriibbuutteess --FFiillee _a_t_t_r_-_f_i_l_e [ _o_p_t_i_o_n... ] aaeeggiiss --CChhaannggee__AAttttrriibbuutteess --EEddiitt [ _o_p_t_i_o_n... ] aaeeggiiss --CChhaannggee__AAttttrriibbuutteess --FFiixx__AARRcchhiitteeccttuurree aaeeggiiss --CChhaannggee__AAttttrriibbuutteess _n_a_m_e==_v_a_l_u_e aaeeggiiss --CChhaannggee__AAttttrriibbuutteess --LLiisstt [ _o_p_t_i_o_n... ] aaeeggiiss --CChhaannggee__AAttttrriibbuutteess --HHeellpp aaeeggiiss --CChhaannggee__AAttttrriibbuutteess --UUUUIIDD _s_t_r_i_n_g [ _o_p_t_i_o_n... ] DDEESSCCRRIIPPTTIIOONN The _a_e_g_i_s _-_C_h_a_n_g_e___A_t_t_r_i_b_u_t_e_s command is used to set, edit or list the attributes of a change. The output of the --LLiisstt variant is suitable for use as input at a later time. See _a_e_c_a_t_t_r(5) for a description of the file format. The _n_a_m_e==_v_a_l_u_e form of the command may be used when you wish to add or modify change set attributes. If an attribute is already present, it will be modified; if there is more than one attribute with the same name, only the first will be modified. The _n_a_m_e++==_v_a_l_u_e form will always append the pair. EExxaammppllee When you edit the file, you will see something like this: brief_description = "login(1) is too fussy"; description = "When users type their password " "incorrectly, after three times the login(1) " "program should assume they have forgotten " "their password and automatically reset it " "for them."; cause = external_enhancement; attribute = [ { name = "bugzilla"; value = "666"; }, { name = "customer-priority"; value = "high"; }, { name = "marketing-priority"; value = "urgent-panic-headless-chicken"; }, { name = "engineering-priority"; value = "after-heat-death-of-universe"; } ]; Note the semicolons, you need to get them right. Edit the fields you want to change. When you quit the editor, they will be updated. KKnnoowwnn AAttttrriibbuuttee NNaammeess While many of the anticipated used of change attributes are to allow projects to attach their own specialized data to change sets, Aegis also uses some attributes for its own purposes (and arguably, should always have done so to maximize forwards compatibility across Aegis upgrades). aeget:inventory:hide boolean. If true, this change set does not appear in _a_e_g_e_t(1)'s change set inventory pages, used by _a_e_d_i_s_t _-_r_e_p_l_a_y to decide what to download and apply. Think of it as a "local only" flag. aeget-inventory-hide Do not show this change set in the file inventory. See _a_e_g_e_t(1) for more information. aegis:history_get_command Used when reconstructing file history, and the history tool has been changed at some point in the past. aemakegen:debian:accepted Set to true when a debian package upload has succeeded, and the BTS tells you the bug fixes have been accepted. foreign-copyright boolean. If true, none of the files in this change set will not be checked by the _a_e_d_e_-_p_o_l_i_c_y(1) copyright validation. integrate-begin-hint Suggest options when integrating. See _a_e_i_b(1) for more infor- mation. original-uuid This is set by _a_e_d_i_s_t _-_r_e_c_e_i_v_e when an incoming change set is changed before it can end development. There may be more than one. The _a_e_g_e_t(1) inventory "all" page will show these addi- tional UUIDs, used by the _a_e_d_i_s_t _-_p_e_n_d_i_n_g command.. aegis:history_get_command This is set by _a_e_i_p_a_s_s when integrating a change. See the _C_H_A_N_G_I_N_G _H_I_S_T_O_R_Y _T_O_O_L section of _a_e_p_c_o_n_f(5) for more informa- tion. UUnniivveerrssaall UUnniiqquuee IIddeennttiiffiieerr Each change set is assigned a unique universal identifier (UUID) at _i_n_t_e_g_r_a_t_e _p_a_s_s time. This serves to identify the change across all sites when a geographically distributed development model is being used. This may be exploited to rapidly determine which change sets need to be downloaded. The --UUnniivveerrssaall__UUnniiqquuee__IIDDeennttiiffiieerr option is used by the _a_e_d_i_s_t(1) and _a_e_p_a_t_c_h(1) commands to set the UUID of a change set. It should not be used by developers. UUssiinngg CChhaannggee AAttttrriibbuutteess iinn SSccrriippttss There are several ways you can use the attributes of an Aegis change in a shell script: _a_e_r_e_p_o_r_t(1) The report generator is able to access change attributes. You can then have the report generator print the necessary data. _a_e_s_u_b(1) Many change attributes can be accessed via the _a_e_s_u_b(5) com- mand substitutions, and printed using the _a_e_s_u_b(1) command. aeca -l The list option of the _a_e_c_a(1) command may be used to print the values of all editable change attributes. It can be groped using _g_r_e_p(1) or _a_w_k(1), or similar. _a_e_x_m_l(1) It is possible to get a great deal of information in XML for- mat, including change attributes. This format can be parsed by a variety of packages. Use the method best suited to your particular needs. 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. --DDeessccrriippttiioonn__OOnnllyy This option may be used to specify that only the change description is the subject of this command. It will be pre- sented as plain text, without any of the quotes or escapes present when this command is not used. --EEddiitt Edit the attributes with a text editor, this is usually more convenient than supplying a text file. The _V_I_S_U_A_L and then _E_D_I_T_O_R environment variables are consulted for the name of the editor to use; defaults to _v_i(1) if neither is set. See the _v_i_s_u_a_l___c_o_m_m_a_n_d and _e_d_i_t_o_r___c_o_m_m_a_n_d fields in _a_e_u_c_o_n_f(1) for how to override this specifically for Aegis. Warning: Aegis tries to be well behaved when faced with errors, so the temporary file is left in your home directory where you can edit it further and re-use it with a --ffiillee option. The --eeddiitt option may not be used in the background, or when the standard input is not a terminal. --EEddiitt__BBaacckkGGrroouunndd Edit the attributes with a dumb text editor, this is most often desired when edit commands are being piped into the edi- tor via the standard input. Only the EEDDIITTOORR environment vari- able is consulted for the name of the editor to use; it is a fatal error if it is not set. See the _e_d_i_t_o_r___c_o_m_m_a_n_d field in _a_e_u_c_o_n_f(1) for how to override this specifically for Aegis. --FFiillee _f_i_l_e_n_a_m_e Take the attributes from the specified file. The filename `-' is understood to mean the standard input. -Fix_ARchitecture This option may be used to replace change change's architec- ture list with all of the mandatory architectures from the project configuration file, plus any of the optional architec- tures that match the current machine. May not be used with -file or -edit options. --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. --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. --UUnniivveerrssaall__UUnniiqquuee__IIDDeennttiiffiieerr _s_t_r_i_n_g This option may be used to set the UUID of change change. --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 aeca 'aegis -ca \!* -v' sh$ aeca(){aegis -ca "$@" -v} EERRRROORRSS It is an error if the current user is not an administrator 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 _t_k_a_e_c_a(1) GUI interface to the _a_e_c_a(1) command. _a_e_c_a_t_t_r(5) change attributes file format _a_e_c_s_t_a_t_e(5) change state file format _a_e_p_a(5) modify the attributes of a project _a_e_s_u_b(5) available command substitutions _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 -Change_Attributes(1)