SIMPLE SOLUTIONS

AEB(1) - man page online | user commands

Build a change.

Chapter
*(N)
aegis -Build(1)                      General Commands Manual                      aegis -Build(1)

NAME aegis build - build a change
SYNOPSIS aegis -Build [ option... ][ filename... ] aegis -Build -List [ option... ] aegis -Build -Help
DESCRIPTION The aegis -Build command is used to build a project. The project configuration file is consulted for the appropriate build command, and that command is executed (see the build_ command and integration_build_command fields in aepconf(5) for more information.) Output of the command is automatically logged to the aegis.log file at the root of the develop‐ ment directory tree. The build command will be executed with its current directory being the root of the development directory, irrespective of there the aegis -Build command was executed. If the change is in the being integrated state, references to the development directory, above, should be read as the integration directory. Integration build commands are exe‐ cuted 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. No Build Required It is possible to configure your project so that no build is required. To do this, set the following build_command = "exit 0"; in the project configuration file. Process Side Effects This command will cancel any test registrations, because building the project logically invalidates them. If the project configuration file was deleted, any diff registration will also be canceled. Notification The actions of the command are controlled by the build_ command and integration_build_‐ command fields of the project config file. See aepconf(5) for more information. File Action Adjustment When this command runs, it first checks the change files against the projects files. If there are inconsistencies, the file actions will be adjusted as follows: create If a file is being created, but another change set is integrated which also cre‐ ates the file, the file action in the change set still being developed will be adjusted to "modify". modify If a file is being modified, but another change set is integrated which removes the file, the file action in the change set still being developed will be adjusted to "create". remove If a file is being removed, but another change set is integrated which removes the file, the file will be dropped from the change set still being developed.
PARTIAL BUILD 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 being integrated state, but can often be useful in the being developed 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. File Name Interpretation 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 integra‐ tion 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 nec‐ essary. 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 -BAse_RElative 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 relative_filename_preference in the user configuration file may be used to modify this default behavior. See aeuconf(5) for more information.
THE BASELINE LOCK 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 aeb(1), aecp(1) and aed(1) commands) take a baseline read lock. This is a non-exclusive lock, so the concurrent development of changes is not hindered. The command which modifies the baseline, aeipass(1), takes a baseline write lock. This is an exclusive lock, forcing aeipass(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 aegis -Integrate_PASS 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 com‐ mands 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.
METRICS 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 aemetrics(5). The name of the metrics file defaults to “filename,S”, however it may be varied, by set‐ ting the metrics_filename_pattern field of the project config file. See aepconf(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 rel‐ evant metrics for that file, and proceeds silently; it is not an error.
OPTIONS The following options are understood: name=value 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. -BAse_RElative This option may be used to cause relative filenames to be considered relative to the base of the source tree. See aeuconf(5) for the corresponding user prefer‐ ence. -CUrrent_RElative This option may be used to cause relative filenames to be considered relative to the current directory. This is usually the default. See aeuconf(5) for the cor‐ responding user preference. -Change number This option may be used to specify a particular change within a project. See aegis(1) for a complete description of this option. -Help This option may be used to obtain more information about how to use the aegis program. -List This option may be used to obtain a list of suitable subjects for this command. The list may be more general than expected. -MINImum This option may be used to request a source-only development_directory_style. This is useful if you want to simulate something like aeib -minimum in the devel‐ opment directory. This option is only meaningful if development_directory_style is being used. If the change is in the being integrated state, and the developer specified -MINImum when issuing the aegis -Integrate_Begin command, then this option is set by default. -Not_Logging 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. -Project name This option may be used to select the project of interest. When no -Project option is specified, the AEGIS_PROJECT environment variable is consulted. If that does not exist, the user's $HOME/.aegisrc file is examined for a default project field (see aeuconf(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. -TERse This option may be used to cause listings to produce the bare minimum of informa‐ tion. It is usually useful for shell scripts. -Verbose This option may be used to cause aegis to produce more output. By default aegis only produces output on errors. When used with the -List option this option causes column headings to be added. -Verify_Symbolic_Links This option may be used to request that the symbolic links, or hard links, or file copies, in the work area be updated to reflect the current state of the baseline. This is controlled by the development_directory_style field of the project configuration file. Only files which are not involved in the change are updated. See also the “symbolic_links_preference” field of aeuconf(5). This option is the default, if meaningful for your configuration. The name is an his‐ torical accident, hard links and file copies are included. -Assume_Symbolic_Links This option may be used to request that no update of baseline mirror files take place. This options is useful when you definitely know the files' up-to-date- ness isn't important right now; incorrect use of this option may have unantici‐ pated build side-effects. See also the “symbolic_links_preference” field of aeu‐ conf(5). This option is the default, if not meaningful for your configuration. The name is an historical accident, hard links and file copies are included. -Wait 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 lock_wait_preference if not specified, see aeuconf(5) for more information. -No_Wait 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 lock_wait_prefer‐ ence if not specified, see aeuconf(5) for more information. See also aegis(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 com‐ bination of both, case is not important. For example: the arguments "-project, "-PROJ" and "-p" are all interpreted to mean the -Project 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 aegis are long, this means ignoring the extra leading '-'. The "--option=value" convention is also understood.
ERRORS 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 being developed or being integrated states. It is an error if a partial build is requested and the change is in the being integrated state.
EXIT STATUS The aegis command will exit with a status of 1 on any error. The aegis command will only exit with a status of 0 if there are no errors.
ENVIRONMENT VARIABLES See aegis(1) for a list of environment variables which may affect this command. See aep‐ conf(5) for the project configuration file's project_specific field for how to set envi‐ ronment variables for all commands executed by Aegis.
SEE ALSO aedb(1) begin development of a change aecp(1) file copy also takes a baseline read lock (non-exclusive) aeib(1) begin integration of a change aeipass(1) integrate pass takes a baseline write lock (exclusive) aet(1) run tests aemetrics(5) metrics values file format aepconf(5) project configuration file format aeuconf(5) user configuration file format
AUTHOR Peter Miller E-Mail: @canb.auug.org.au /\/\* WWW: http://www.canb.auug.org.au/~millerp/
Reference Manual Aegis aegis -Build(1)
This manual Reference Other manuals
aeb(1) referred by aeclean(1) | aeclone(1) | aecp(1) | aecvsserver(1) | aed(1) | aedb(1) | aede(1) | aedist(1) | aegis(1) | aeib(1) | aeipass(1) | aelock(1) | aemv(1) | aemvu(1) | aenrls(1) | aepatch(1) | aepconf(5) | aerevml(1) | aerm(1) | aet(1)
refer to aecp(1) | aed(1) | aedb(1) | aegis(1) | aeib(1) | aeipass(1) | aemetrics(5) | aepconf(5) | aet(1) | aeuconf(5) | conf(5)