--- name: "aeip" section: "1" platform: "linux" package: "aegis" version: "3.8-4" release: "Debian 2.1 (Slink)" platforms: ["linux"] url: "https://new.carta.tech/aeip" --- # aeip(1) pass a change integration ## NAME aegis -Integrate\_Pass - pass a change integration ## SYNOPSIS **aegis** **-Integrate\_Pass** \[ *option*... \]\ **aegis** **-Integrate\_Pass** **-List** \[ *option*... \]\ **aegis** **-Integrate\_Pass** **-Help** ## DESCRIPTION The *aegis* *-Integrate\_Pass* command is used to notify aegis that a change has passed integration. The change is advanced from the *being integrated* state to the *completed* state. This command updates the file histories, so that future [*aecp*(1)](/aecp/1.md) commands may extract previous file versions from history, and so that future [*aed*(1)](/aed/1.md) commands may merge out-of-date files. The history is updated using the *history\_create\_command* and *history\_put\_command* from the project *config* file (see [*aepconf*(5)](/aepconf/5.md) for more information. The integrate pass will abort with an error if one of these history commands should fail, e.g. by running out of disk space. If this should happen, the change will remain in the *being integrated* state, and the integration directory is unaltered. The integration directory is renamed as the baseline directory, and the baseline directory is deleted. The modification times of all files modified since the beginning of integration (see [*aeib*(1)](/aeib/1.md) for more information) are updated to be since the beginning of integrate pass. The order of modification times will be preserved, however the time range will be compressed to the greatest extent possible. This ensures that subsequent development builds will notice that baseline files have changed. Once integrate pass is complete the change is no longer assigned to the current user. ## 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)](/aeb/1.md), [*aecp*(1)](/aecp/1.md) and [*aed*(1)](/aed/1.md) 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, [*aeip*(1)](/aeip/1.md), takes a baseline *write* lock. This is an exclusive lock, forcing [*aeip*(1)](/aeip/1.md) 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 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. ### The History Lock Where a project has a number of branches active simultaneously, it is possible for independent integrate pass commands for different branches to be issued very close together. The is an exclusive *history lock* taken by integrate pass to ensure that only one branch is updating the file history at a time, thus preventing history file corruption. ## TEST CORRELATIONS The \`\`aegis -Test -SUGgest'' command may be used to have aegis suggest suitable regression tests for your change, based on the source files in your change. This automatically focuses testing effort to relevant tests, reducing the number of regression tests necessary to be confident that you have not introduced a bug. The test correlations are generated by the \`\`aegis -Integrate\_Pass'' command, which associates each test in the change with each source file in the change. Thus, each source file accumulates a list of tests which have been associated with it in the past. This is not as exact as code coverage analysis, but is a reasonable approximation in practice. The [*aecp*(1)](/aecp/1.md) and [*aenf*(1)](/aenf/1.md) commands are used to associate files with a change. While they do not actively perform the association, these are the files used by [*aeip*(1)](/aeip/1.md) and [*aet*(1)](/aet/1.md) to determine which source files are associated with which tests. ### Test Correlation Accuracy Assuming that the testing correlations are accurate and that the tests are evenly distributed across the function space, there will be a less than *1/number* chance that a relevant test has not been run by the \`\`aegis -Test -SUGgest *number*'' command. A small amount of noise is added to the test weighting, so that unexpected things are sometimes tested, and the same tests are not run every time. Test correlation accuracy can be improved by ensuring that: - • Each change should be strongly focused, with no gratuitous file inclusions. This avoids spurious correlations. - • Each item of new functionality should be added in an individual change, rather than several together. This strongly correlates tests with functionality. - • Each bug should be fixed in an individual change, rather than several together. This strongly correlates tests with functionality. - • Test correlations will be lost if files are moved. This is because correlations are by name. The best way for tests to correlate accurately with source files is when a change contains a test and exactly those files relating to the functionality under test. Too many spurious files will weaken the usefulness of the testing correlations. ## OPTIONS The following options are understood: - **-Change** *number* This option may be used to specify a particular change within a project. When no **-Change** option is specified, the *AEGIS\_CHANGE* environment variable is consulted. If that does not exist, the user's *$HOME/.aegisrc* file is examined for a default change field (see [*aeuconf*(5)](/aeuconf/5.md) 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. - **-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. - **-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)](/aeuconf/5.md) 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 information. 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. - **-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)](/aeuconf/5.md) 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\_preference* if not specified, see [*aeuconf*(5)](/aeuconf/5.md) for more information. See also [*aegis*(1)](/aegis/1.md) 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 **-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. ## RECOMMENDED ALIAS The recommended alias for this command is ``` csh% alias aeipass 'aegis -ipass \!* -v' sh$ aeipass(){aegis -ipass $* -v} ``` ## 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 the *being integrated* state.\ It is an error if there has been no successful *'aegis -Build'* command for the integration.\ It is an error if there has been no successful *'aegis -Test'* command for the integration.\ It is an error if there has been no successful *'aegis -Test -BaseLine'* command for the integration. ## 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)](/aegis/1.md) for a list of environment variables which may affect this command.\ ## SEE ALSO - [*aeib*(1)](/aeib/1.md) begin integration of a change - [*aeif*(1)](/aeif/1.md) fail integration of a change - [*aeuconf*(5)](/aeuconf/5.md) user configuration file format\ ## COPYRIGHT aegis version 3.8.D001\ Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998 Peter Miller; All rights reserved. The aegis program comes with ABSOLUTELY NO WARRANTY; for details use the '*aegis -VERSion License*' command. This is free software and you are welcome to redistribute it under certain conditions; for details use the '*aegis -VERSion License*' command.\ ## AUTHOR | | | | | --- | --- | --- | | Peter Miller | E-Mail: | millerp@canb.auug.org.au | | `/\/\*` | WWW: | http://www.canb.auug.org.au/~millerp/ |