|
NAMEaepconf - aegis project configuration fileSYNOPSISproject/baseline/aegis.conf (default)project/baseline/config (obsolete) DESCRIPTIONA project configuration file is used to store information about a project. This file is under source control, and is one of the project's source files. Developers may thus modify this file as part of a change.As of aegis.4.17, it is possible to assign any arbitrary name to the project configuration file or files. See aenf(1) for more information. This file contains a number of commands to be executed by Aegis. There are times when the substitutions in these commands may contain shell special characters, which would change the meaning of the commands in unintended ways. There are two main sources of these problems: file names and architecture names. In order to have shell special characters in filenames, you must set the shell_safe_filenames field (see below) to false. If you do this, you will need to use the quote substitution (see aesub(5)) to quote them, so that the shell does not abuse them. Other things which may need quoting include architecture names if you get creative, and edit numbers if unusual ones are generated by your history tool. Getting StartedBecause the project aegis.conf file is under source control like any other file, you must create the project aegis.conf file in the very first change of your project. Use the$ aenf aegis.conf $ If you ever need to change one of the fields of the project aegis.conf file, you do this the same way as for any other source file, by copying it into a change using the $ aecp aegis.conf $ If you would prefer a different name for the project configuration file, use the aenf -config option. For example, the $ aenf -config project.configuration $ CONTENTSThis file contains the following fields:
This field names a directory which will be searched for
additional configuration files. (This directive is only legal or meaningful in
the master project aegis.conf file.)
All source files (change source files and project source files) present in this directory will be read in as if they were added to the end of the project "aegis.conf" file. The usual priority of files (development directory, branch baseline, etc, project trunk baseline) is observed when these files are read. Please note that the physical directories are never searched, only the Aegis concept of the change and project files is consulted (i.e. files created and modified in the usual way with aenf(1) and aecp(1) commands). Placing additional files in the physical directories will have no effect. It is recommended that if you use this field at all, that your top level project aegis.conf file should only contain this one field. This is to avoid overly‐large re‐reading of this file when it is joined to all the others.
This field describes how to build the project (actually,
how to do an integration build). This field is mandatory. Used by the
aeb(1) command. All of the substitutions described by aesub(5)
are available.
Executed as: the integrator (for integration builds) or the developer (for development builds). Current directory: the integration directory of the change (for integration builds) the development directory of the change (for development builds). Exit status: zero is considered success, non‐zero is a failure and a subsequent successful (exit zero) build will be required. If this field is set to "exit 0" then no integration build will be required, and will not be checked for by the aeipass(1) command.
This field describes how to do a development build. If
this field is absent, it defaults to the above. Used by the aeb(1)
command. All of the substitutions described by aesub(5) are available.
Executed as: the developer. Current directory: the development directory of the change. Exit status: zero is considered success, non‐zero is a failure and a subsequent successful (exit zero) build will be required. If this field is set to "exit 0" then no development build will be required, and will not be checked for by the aede(1) command.
This field encapsulates a set of parameters controlling
the appearance of the development directory. It has significant implications
for the way the DMT is used, and the directory appearance presented to the
DMT.
This field is true if hard links are to be used for
project source files (which are not part of the change) so that the work area
has a complete set of source files.
Defaults to false if not set. If the host system does not have hard links, this field will be ignored. Maintaining the hard links can be time consuming for large projects, and add quite a noticeable delay before builds start doing anything. If possible, change your build system to use the $search_path substitution instead and avoid links.
This field is true if symbolic links are to be used for
project source files (which are not part of the change) so that the work area
has a complete set of source files.
Defaults to false if not set. [If the obsolete create_symlinks_before_build field is set, defaults to the value of that field, with a warning.] If (source_file_link == true and hard links are available) this field will be ignored. If the host system does not have symbolic links, this field will be ignored. Maintaining the symbolic links can be time consuming for large projects, and add quite a noticeable delay before builds start doing anything. If possible, change your build system to use the $search_path substitution instead and avoid symbolic links.
This field is true if copies are to be used for project
source files (which are not part of the change) so that the work area has a
complete set of source files. File modification time attributes will be
preserved.
Defaults to false if not set. If ((source_file_link == true and hard links are available) OR (source_file_symlink == true and symbolic links are available)) this field will be ignored. Maintaining the copies can be time consuming (and space consuming) for large projects, and add quite a noticeable delay before builds start doing anything. If possible, change your build system to use the $search_path substitution instead and avoid file copies.
The source_file_whiteout field mat be used to
specify the presence (true) or absence (false) of white‐out files, used
to "cover up" files being removed by a change set. These files
contain 1kB of random data, intended to cause a syntax error should be build
reference them.
It is rarely necessary to explicitly set this field. It defaults to false if you set any of the source_file_link, source_file_symlink or source_file_copy to true; it defaults to true only if none of them are true. Not meaningful (always false) for integration builds.
This field is true if hard links are to be used for
non‐source files which are present in the project baseline(s) but which
are not present in the work area, so that the work area has a complete set of
derived files. This allows work areas to take advantage of
"precompiled" object files (etc) in the baseline(s).
Defaults to false if not set. If the host system does not have hard links, this field will be ignored. Maintaining the links can be time consuming for large projects, and add quite a noticeable delay before builds start doing anything. If possible, change your build system to use the $search_path substitution instead and avoid hard links. Alternatively, set derived_at_start_only = true; and your work area will get a "head start" but the derived files will not be checked for every build, but this will occasionally result in long build times after integrations. See also the integrate_begin_exceptions and symlink_exceptions fields (they apply to hard links as well as symbolic links).
This field is true if symbolic links are to be used for
non‐source files which are present in the project baseline(s) but which
are not present in the work area, so that the work area has a complete set of
derived files. This allows work areas to take advantage of
"precompiled" object files (etc) in the baseline(s).
Defaults to false if not set. [If the obsolete create_symlinks_before_build field is set, defaults to the value of that field, with a warning.] If (derived_file_link == true and hard links are available) this field will be ignored. If the host system does not have symbolic links, this field will be ignored. Maintaining the symbolic links can be time consuming for large projects, and add quite a noticeable delay before builds start doing anything. If possible, change your build system to use the $search_path substitution instead and avoid symbolic links. Alternatively, set derived_at_start_only = true; and your work area will get a "head start" but the derived files will not be checked for every build, occasionally resulting in long build times after integrations. See also the integrate_begin_exceptions and symlink_exceptions fields.
This field is true if copies are to be used for
non‐source files which are present in the project baseline(s) but which
are not present in the work area, so that the work area has a complete set of
derived files. This allows work areas to take advantage of
"precompiled" object files (etc) in the baseline(s).
Defaults to false if not set. If ((derived_file_link == true and hard links are available) or (derived_file_symlink == true and symbolic links are available)) this field will be ignored. Maintaining the copies can be time consuming (and space consuming) for large projects, and add quite a noticeable delay before builds start doing anything. If possible, change your build system to use the $search_path substitution instead and avoid symbolic links. Alternatively, set derived_at_start_only = true; and your work area will get a "head start" but the derived files will not be checked for every build, occasionally resulting in long build times after integrations. See also the integrate_begin_exceptions and symlink_exceptions fields (they apply to copies as well as symbolic links).
This field is set to true if you want the symbolic links,
hard links and/or copies removed again after each build. This allows the user
to maintain the illusion of using a search path, without actually doing so.
This option is not especially efficient.
Defaults to false if not set. [If the obsolete remove_symlinks_after_build field is set, defaults to the value of that field, with a warning.] If this field is false, the development directory will be populated by the develop begin (aedb) command, and the integration directory will be populated by the integrate begin (aeib) command.
This field controls whether the above fields controlling
the appearance of derived files are acted upon before every build (false) or
only when the work area is created (true).
Defaults to false if not set. This field is ignored if the during_build_only field is true. This field can be complex. Here are a few examples; but much, much more is possible. The first example will get you a development directory very similar to one presented by CVS: development_directory_style = { source_file_copy = true; }; development_directory_style = { source_file_link = true; source_file_symlink = true; source_file_copy = true; }; The development directory style is applied after the develop_begin_command hook is run.
This field encapsulates a set of parameters controlling
the appearance of the integration directory. It has significant implications
for the way the DMT is used, and the directory appearance presented to the
DMT.
Defaults to the value of the development_directory_style field if not set. Note that the obsolete create_symlinks_before_integration_build and remove_symlinks_after_integration_build fields affect this default (with a warning) but only if they are explicitly set. Note that the link_integration_directory field is still relevant. That field controls how the baseline is cloned to form the integration directory. This field operates after that operation.
This command is run when Aegis adjusts the
last‐time‐modified time‐stamp on files in the integration
directory. If the build tool uses additional information to supplement file
modification times, this command gives you the opportunity to re‐sync
the associated database.
Executed as: the project owner. Current directory: the integration directory. This is what is about to be come the new baseline. Exit status: NOT ignored. Note that a failure here puts the change in a partial state from which recovery may be difficult. Best to define this command with a set+e so that errors are ignored at the command level.
This field is set to true if the build command, when
executed on any architecture, results in all architectures being built. This
may be accomplished, for example, by using cross‐compilation
techniques, or Cook's ability to nominate hosts on which to execute each build
rule.
This field is set to true if the test command, when
executed on any architecture, results in all architectures being tested. This
may be accomplished, for example, by using Cook's ability to nominate hosts on
which to execute each test rule.
This field contains a command to be executed whenever a
´aegis -CoPy_file´, ´aegis -New_File´
´aegis -New_Test´ ´aegis -MoVe_file´ or
´aegis -ReMove_file´ command is successful. See also
command‐specific overrides. If this field is absent, nothing is done.
Used by the aecp(1), aenv(1), aenf(1), aerm(1),
and aemv(1) commands. All of the substitutions described by
aesub(5) are available; in addition,
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
This field contains a command to be executed whenever a
´aegis -CoPy_file_Undo', ´aegis -MoVe_file_Undo' ´aegis
-New_File_Undo', ´aegis -New_Test_Undo', or ´aegis
-ReMove_file_Undo' command is successful. Default to
change_file_command if absent. See also command‐specific
overrides. If both fields are absent, nothing is done. Used by the
aecpu(1), aemvu(1), aenfu(1), aentu(1) or
aermu(1), commands. All of the substitutions described by
aesub(5) are available; in addition,
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
Executed whenever the aegis -new_file command is run
successfully. Defaults to `change_file_command' if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
Executed whenever the aegis -new_test command is run
successfully. Defaults to `change_file_command' if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
Executed whenever the aegis -copy_file command is run
successfully. Defaults to `change_file_command' if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
Executed whenever the aegis -remove_file command is run
successfully. Defaults to `change_file_command' if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
Executed whenever the aegis -new_file_undo command is run
successfully. Defaults to change_file_undo_command if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
Executed whenever the aegis -new_test_undo command is run
successfully. Defaults to change_file_undo_command if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer Current directory: the development directory of the change Exit status: ignored
Executed whenever the aegis -copy_file_undo command is
run successfully. Defaults to change_file_undo_command if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer Current directory: the development directory of the change Exit status: ignored
Executed whenever the aegis -remove_file_undo command is
run successfully. Defaults to change_file_undo_command if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer Current directory: the development directory of the change Exit status: ignored
The make_transparent_command is executed whenever the
aegis -make_transparent command is run successfully. Defaults to
change_file_command if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer Current directory: the development directory of the change Exit status: ignored
The make_transparent_undo_command is executed whenever
the aegis -make_transparent_undo command is run successfully. Defaults to
change_file_undo_command if not set.
All of the substitutions described in aesub(5) are available. In addition:
Executed as: the developer Current directory: the development directory of the change Exit status: ignored
This field contains a command to be executed during a
development build before the development build command above, when (a)
it is the first build after a develop begin, or (b) some other change has been
integrated into the baseline since the last build. If this field is absent,
nothing is done. Used by the aeb(1) command. All of the substitutions
described by aesub(5) are available.
This field contains a command to be executed at the
beginning of a 'aegis -Develop_Begin' command, immediately after the
development directory has been created. If this field is absent, nothing is
done. Used by the aedb(1) command. All of the substitutions described
by aesub(5) are available.
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored. Note: This command is run from inside the lock, so running any Aegis command that modifies the change state will cause a deadlock.
This field contains a command to be executed whenever a
'aegis -Develop_Begin' command is successful. If this field is absent, nothing
is done. Used by the aedb(1) command. All of the substitutions
described by aesub(5) are available.
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
This field contains a command to be executed whenever a
'aegis -Develop_Begin_Undo' command is successful. If this field is absent,
nothing is done. Used by the aedbu(1) command. All of the substitutions
described by aesub(5) are available.
Executed as: the developer. Current directory: wherever the command was executed from. Exit status: ignored.
This field contains a command to be executed whenever a
'aegis -Integrate_Begin' command is successful. If this field is absent,
nothing is done. Used by the aeib(1) command. All of the substitutions
described by aesub(5) are available.
Executed as: the project owner. Current directory: the integration directory. Exit status: ignored.
This field is used to create a new history. The command
is always executed as the project owner. Used by the aeipass(1)
command.
It is strongly recommended that the history_create_command and history_put_command fields are identical. If not set, the history_create_command field defaults to the same value as the history_put_command field. All of the substitutions described by aesub(5) are available; in addition,
See also the history_put_trashes_file field, below. Executed as: the project owner. Current directory: the base of the history tree. Exit status: zero indicates success, all non‐zero exits indicate failure (the integrate pass will fail). Note: For projects created Aegis 4.26 or later, it is possible to change the history tool used by the project simply changing the various history_*_command documented in this man page. It is also possible to change the history tool for projects created with aeimport 4.26 or later, however the original tool must be available to access older file's revisions.
This field is used to get a file from history. The
command may be executed by developers. Used by the aeipass(1) and
aecp(1) commands. All of the substitutions described by aesub(5)
are available; in addition,
Executed as: the developer (or the executing user, in the case of the -independent option). Current directory: the base of the history tree Exit status: zero indicates success, all non‐zero exits indicate failure (the aecp will fail).
This field is used to add a new change to the history.
The command is always executed as the project owner. Used by the
aeipass(1) command.
It is strongly recommended that the history_put_command and history_create__command fields are identical. If not set, the history_put_command field defaults to the same value as the history_create_command field. All of the substitutions described by aesub(5) are available; in addition,
See also the history_put_trashes_file field, below. Executed as: the project owner. Current directory: the base of the history tree. Exit status: zero indicates success, all non‐zero exits indicate failure (the integrate pass will fail).
The history_transaction_begin_command field is used to
specify a command to be run by aeipass(1) before any history create or
history put commands are run. The default is to do nothing.
All of the substitutions described in aesub(5) are available. If you need a transaction ID, use the $version substitution. Executed as: the project owner. Current directory: the base of the history tree. Exit status: zero indicates success, all non‐zero exits indicate failure (the integrate pass will fail).
The history_transaction_end_command field is used to
specify a command to be run by aeipass(1) after any history create or
history put commands are run, but before any history query commands are run.
The default is to do nothing.
All of the substitutions described in aesub(5) are available. If you need a transaction ID, use the $version substitution. Executed as: the project owner. Current directory: the base of the history tree. Exit status: zero indicates success, all non‐zero exits indicate failure (the integrate pass will fail).
The history_transaction_abort_command field is used to
specify a command to be run by aeipass(1) to indicate that a
transaction has been abandoned. The default is to do nothing.
All of the substitutions described in aesub(5) are available. If you need a transaction ID, use the $version substitution. Executed as: the project owner. Current directory: the base of the history tree. Exit status: ignored (the integrate pass has already failed).
This field is used to query the topmost edit of a history
file. Result to be printed on the standard output. This command may be
executed by developers. Used by the aeipass(1) and aecp(1)
commands. All of the substitutions described by aesub(5) are available;
in addition,
Executed as: the project owner. Current directory: the base of the history tree. Exit status: zero indicates success, all non‐zero exits indicate failure (the integrate pass will fail).
This field contains a command to be executed whenever a
aeipass(1) or aedn(1) command is successful. This command is
invoked for every file in the project. So using it incurs a performance
penalty. If this field is absent, nothing is done. All of the substitutions
described by aesub(5) are available; in addition,
Executed as: the project owner. Current directory: the base of the history tree. Exit status: zero indicates success, all non‐zero exits indicate failure (a warning will be issued). Labeling does not scale, so the use of this command is not encouraged. If you have a project with 10,000 files, and a change modified exactly one of them, only one history_put_command execution is required, which operates on one history file. If you have labeling turned on, it will also be necessary to execute 10,000 history_label_commands, to add information Aegis will never use.
Many history tools (e.g. RCS) can modify the contents of
the file when it is committed. While there are usually options to turn this
off, they are seldom used. The problem is: if the commit changes the file, the
source in the repository now no longer matches the object file in the
repository - i.e. the history tool has compromised the referential integrity
of the repository.
This field describes the content style which the history
tool is capable of working with.
When a file is added to the history (by either the history_create_command or the history_put_command field) it is examined for conformance to this limitation. If there is a problem, the file is encoded in either quoted printable for MIME64, whichever is smaller, before being given to the history tool. This encoding is transparent, the file in the baseline is unchanged. On extract (the history_get_command field) the encoding is reversed, using information attached to the change file information. This is because each put could use a different encoding (although in practice, file contents rarely change that dramatically, and the same encoding is likely to be deduced every time). Please note that this field does not apply to the diff_command or merge_command fields.
This field is used to difference of 2 files. The command
is always executed by developers. Used by the aed(1) command. All of
the substitutions described by aesub(5) are available; in addition,
Executed as: the project owner (for integration diffs), or the developer (for development diffs). Current directory: the integration directory (for integration diffs), or the development directory (for development diffs). Exit status: zero indicates success, all non‐zero exits indicate failure (the aed will fail). Note: It is possible to configure a project to omit the diff step as unnecessary, by the following setting: diff_command = "exit 0";
This disables all generation, checking and validation of difference file for
each change source file. The merge functions of the aediff(1) command
are unaffected by this setting.
This field is used to merge two competing edits to a
file. The command is always executed by developers. The current directory will
be the development directory. This field is used by the aed(1) command.
All of the substitutions described by aesub(5) are available; in
addition,
It is important that this command does not move files around. (See the obsolete diff3_command field, below, for some history.) Executed as: the project owner (for integration diffs), or the developer (for development diffs). Current directory: the integration directory (for integration diffs), or the development directory (for development diffs). Exit status: zero indicates success, all non‐zero exits indicate failure (the aed will fail).
The difference of 2 files, to send around as a patch.
(This isn't the same as diff_command, because it's aimed at GNU Patch, not at
humans.) The command is always executed by developers. Used by the
aepatch(1) command.
Defaults to "set +e; diff -c -L $index -L $index $original $input > $output; test $? -le 1" if not set. All of the substitutions described by aesub(5) are available; in addition,
Executed as: the project owner (for integration diffs), or the developer (for development diffs). Current directory: the integration directory (for integration diffs), or the development directory (for development diffs). Exit status: zero indicates success, all non‐zero exits indicate failure (the aed will fail).
The difference of 2 files, for the use of the
aeannotate(1) command. (This isn't the same as the diff_command
field, because it's aimed at aeannotate(1), not at humans.) The command
is always executed by developers. Used by the aeannotate(1) command.
Extreme care should be taken if you are considering setting this field, otherwise the result reported by aeannotate(1) may bear little relation to reality. The most useful option is GNU diff's --ignore‐all‐space option, which will have the effect of ignoring the majority of indenting and code formatting changes. The --ignore‐case option could also be useful for case insensitive languages such as FORTRAN or PL/1. Avoid options which would alter the number of lines, such as - -ignore‐blank‐lines or --context as these will produce misleading results. Defaults to "set +e; diff $option $original $input > $output; test $? -le 1" if not set. All of the substitutions described by aesub(5) are available; in addition,
Executed as: the project owner (for integration diffs), or the developer (for development diffs). Current directory: the integration directory (for integration diffs), or the development directory (for development diffs). Exit status: zero indicates success, all non‐zero exits indicate failure (the aed will fail).
This field is used to set the command to be executed by
the aerpass(1) command. This command is useful in cases where the
enterprise has determined that more than one review is necessary or that the
reviewer must be senior to the developer, etc. Defaults to
"exit 0" if not set.
The exit status is examined. An zero exit status (success) means that the change will proceed to the awaiting integration state; a non‐zero exit status (failure) means that the change requires further review state, and the develop_end_action is consulted to determine the appropriate state (awaiting_review or being_reviewed) for the change to move to. All of the substitutions described by aesub(5) are available. Of particular interest are ${Change_Developer_List} and ${Change_Reviewer_List} for passing the specific staff involved with the change. Executed as: the current reviewer. Current directory: the development directory. Exit status: zero indicates success, non‐zero indicates failure. For example, to have a script which is a project source file to be used to gate the code review process, a setting such as the following may be used: review_policy_command =
"$sh ${source script/reviewpolicy.sh} "
"-p $project -c $change "
"-d ${developer_list} "
"-r ${reviewer_list}"
;
This is only one of many ways to implement a project specific review
policy.
This field is used to set the command to be executed by
the aede(1) command. This command is useful in cases where the
enterprise has determined that additional pre‐conditions must be met
(in addition to those already imposed by the aede(1) command) before a
change may leave the being developed state. Defaults to
"exit 0" if not set.
The exit status is examined. An zero exit status (success) means that the change may leave to the being developed state; a non‐zero exit status (failure) means that the change requires further development. All of the substitutions described by aesub(5) are available. Executed as: the developer. Current directory: the development directory. Exit status: zero indicates success, non‐zero indicates failure. There are some common validations available in the aede‐policy(1) command; you may choose all or only some of them, or you may choose to write a policy command specific to your project.
This field may be used to control what happens when
development of a change is ended, and the change contains files which have not
had their contents or their attributes changed.
This field may be used to control what happens when a
change is completed, and the change contains files which have not had their
contents or their attributes changed.
This field is used to set the command to be executed by
the aet(1) command. Defaults to "$shell $file_name" if not
set.
All of the substitutions described in aesub(5) are available. In addition:
Note that tests are source files, and thus never have the execute bit set. Executed as: the project owner (for integration tests) or the developer (for development tests), or the executing user (for -independent tests). Current directory: the integration directory (for integration tests), the development directory (for development tests), the project baseline (for -bl tests), or the current directory (for -independent tests). Exit status: zero indicates success, one indicates failure, anything else indicates "no result".
This field is used to set the command to be executed by
the aet(1) command when a change is in the being developed
state. Defaults to be the same as the test_command field if not set.
Note: It is a significantly bad idea to make tests behave differently in being development and being integrated states; avoid this at all costs. All of the substitutions described in aesub(5) are available. In addition:
Note that tests are source files, and thus never have the execute bit set. Executed as: the developer. Current directory: the development directory (for development tests), the project baseline (for -bl tests). Exit status: zero indicates success, one indicates failure, anything else indicates "no result".
This field is used to set the command to be executed by
the aet(1) command, in preference to the test_command or
development_test_command, if set. It is capable of running more than
one test at once.
All of the substitutions described in aesub(5) are available. In addition:
Note that tests are source files, and thus never have the execute bit set. It is strongly recommended that you design your test scripts so that they may be executed by either batch or non‐batch methods. This permits simple migration when your environment changes. Executed as: the project owner (for integration tests) or the developer (for development tests), or the executing user (for -independent tests). Current directory: the integration directory (for integration tests), the development directory (for development tests), the project baseline (for -bl tests), or the current directory (for -independent tests). Exit status: zero indicates success, one indicates failure, anything else indicates "no result".
If this field is present it is used as a command to be
executed in order to further identify the platform architecture (see below).
All of the substitutions described by aesub(5) are available;
Executed as: the developer. Current directory: the development directory of the change. Exit status: zero indicates success, all non‐zero exits indicate failure.
This field is a list of system and machine architectures
on which each change must successfully build and test. May be assigned more
than once. The structures listed have fields as follows:
The system and machine architecture are determined by
using the uname(2) system call. The uname(2) return value is
assembled into a string of the form
"sysname‐release‐version‐machine",
or
"sysname‐release‐version
‐machine‐disc" if
architecture_discriminator_command is used.
The pattern field must match this uname result string. The first match found is used. The pattern is a shell file name pattern, see sh(1) for more information. For example, the pattern SunOS‐4.1*‐*‐sun4* matches a machine the author commonly uses, which returns SunOS‐4.1.3‐8‐sun4m from the uname(2) system call.
The mode field is used to control how the
architecture information is used.
When a change is created, the required architecture names are copied into the change's architecture list. Once names are in this list, they are required for the change, and the project attributes are less relevant. If the architecture field is not set, it defaults to architecture = [ { name = "unspecified"; pattern = "*"; mode = required; } ];
Command to run to initialize the body of the file.
Executed as: the developer. Current directory: the development directory of the change. Exit status: ignored.
All of the substitutions described in aesub(5) are available for the body and body_command strings. (Only specify one of them.) In addition:
All of the substitutions described in aesub(5) are available for the body string. In addition:
If the name of the file being removed does not match any of the filename patterns, a file consisting of 1KB of very ugly garbage will be generated. The idea is that it will produce a syntax error for most languages if you try to run it, compile it, or include it.
This field is used to limit the length of file names. All
new files may not have path components longer than this. Existing files are
not affected. The last component must also allow for the ",D" suffix
of difference files. Where this value is larger than the file system allows,
the file system limit will be imposed. Defaults to 255 if not set. Legal
values range from 9 to 255.
The file name lengths of project files will be checked at develop end if the project aegis.conf file is in the change. See aede (1) for more information.
This field may be used to limit the characters allowed in
file names to only those explicitly allowed by POSIX. Defaults to false if not
set.
For a filename to be portable across conforming implementations of IEEE Std 1003.1‐1988, it shall consist only of alphanumeric characters, dot, hyphen or underscore. Hyphen shall not be used as the first character of a portable filename. If this field is false, all characters are allowed except non‐printing characters, space characters and leading hyphens.
This field may be used to limit file names so that they
may not contain shell special characters. If you do not set this to true, you
will need to use the ${quote} substitution around file names in commands, or
risk unexpected errors.
This field defaults to true if not set. The white space characters (space, tab, newline, etc) are considered shell special characters.
This field may be used to allow white space characters in
file names. This will allow the following characters to appear in filenames:
backspace (BS, \b, 0x08), horizontal tab (HT, \t, 0x09), new line (NL, \n,
0x0A), vertical tab (VT, \v, 0x0B), form feed (FF, \f, 0x0C), and carriage
return (CR, \r, 0x0D).
Defaults to false if not set. Note that this field does not override other file name filters. It will be necessary to explicitly set shell_safe_filenames = false as well. It will be necessary to set dos_filename_required = false (the default) as well. It will be necessary to set posix_filename_charset = false (the default) as well. The user must take great care to use the ${quote} substitution around all file names in commands in the project configuration. And even then, substitutions which expect a space separated list of file names will have undefined results.
This field may be used to allow file names with
non‐ascii‐printable characters in them. Usually this would mean
a UTF8 or international charset of some kind.
Defaults to false if not set. Note that this field does not override other file name filters. It will be necessary to explicitly set shell_safe_filenames = false as well. It will be necessary to set dos_filename_required = false (the default) as well. It will be necessary to set posix_filename_charset = false (the default) as well.
This field is used to form the filename of new tests,
where the filename is not specified on the aent command line. Defaults to
"test/${zpad $hundred 2}/t${zpad $number 4}${left $type 1}.sh" if
not set.
All of the substitutions defined in aesub(5) are available. The following three substitutions are also available:
This field is used to determine the name of the
development directory at develop begin. All of the substitutions defined in
aesub(5) are available. The following substitutions is also available:
If not set, defaults to "$ddd/${left $p ${expr ${namemax $ddd} - ${length .$magic$c}}}.$magic$c". For DOS compatibility (8+3 file names), a useful setting is "$ddd/${downcase ${left ${id $p} 8}.$magic${right 0$c 2}}". This ensures that the filename is always a valid 8.3 filename, that it is always lowercase, and it translates any punctuation in the project name into underscores.
This field is used to form the name of the metrics file,
given a source file. All of the substitutions defined in aesub(5) are
available. The following substitutions is also available:
Defaults to "$filename,S" if not set.
This is a list of name and value pairs for use within the
${project‐specific} substitution (see aesub(5) for more
information). May be assigned more than once. The sub‐fields are
There are almost no limitations on the strings which may appear in either of these fields. There are several attribute names which are known to and used by Aegis, these include:
When commands are executed by Aegis, it ensures that the AEGIS_PROJECT, AEGIS_CHANGE, AEGIS_ARCH, LINES and COLS environment variables are set appropriately. The project configuration file's project_specific field is also consulted, looking for value's whose name starts with "setenv:" and sets the corresponding environment variable. All of the substitutions described by aesub(5) are available. For example: specifying a PATH and a SEARCH_PATH to be used for all commands may be set as follows: project_specific = [ { name = "setenv:PATH"; value = "/usr/bin:/bin"; }, { name = "setenv:SEARCH_PATH"; value = "${search_path}"; }, ];
This field controls the adjustment of file modification
times at the end of integrate‐pass. File times are adjusted so that
development directories are, in the main, out of date with respect to the
baseline. The idea is that, at the very least, programs need to be
re‐linked so that aet -reg does not give false negatives.
Combining this with the project_file_command (above) can alleviate the vast majority of file modification time inconsistencies experienced as a result of a project integration and the subsequent changes in the baseline's file modification times. Unless you are a masochist, do not set this field. Leave it as the default.
See also the build_time_adjust_notify_command field.
If this field is set each aedb(1),
aechown(1), aede(1) and aerpass(1) will append a
Signed‐off‐by line to the change
description. This field should only be set to true for open source projects.
For a description of Signed‐off‐by see http://www.ussg.iu.edu/hypermail/linux/kernel/0405.2/1301.html and http://www.osdl.org/newsroom/press_releases/2004/2004_05_24_dco.html
It is possible to have Aegis cache the list of project
files that were present at integrate pass for each delta (integrated change
set). This is used to optimize all project‐history‐based
operations, such as aecp -delta or aepatch(1).
This cache will optimize many operations which would otherwise require time to reconstruct the project state using the roll‐forward data available in each change set. However, it comes at the cost of disk space, and not everyone can afford more and more disk. This field defaults to true if not set.
It is possible to have Aegis exclude from the clean
process any file that match one of the pattern listed in the clean_exceptions
list.
This field default to an empty list if not set.
It is possible to have Aegis cache the list of project
files that were present at integrate pass for each delta (integrated change
set). This is used to optimize all project‐history‐based
operations, such as aecp -delta or aepatch(1).
This cache will optimize many operations which would otherwise require time to reconstruct the project state using the roll‐forward data available in each change set. However, it comes at the cost of disk space, and not everyone can afford more and more disk. This field defaults to true if not set. RSS FEEDSAegis has the ability to feed RSS channels when change sets transition states. See the User Guide for full details. Following is a brief description of the project‐specific attributes used to control this process.
An RSS channel is specified with the rss:feedfilename
project_specific attribute:
project_specific = [ { name = "rss:feedfilename-<filename>"; value = "<space‐separated list of states>"; } ]
The description of an RSS channel is specified with the
rss:feeddescription project_specific attribute:
project_specific = [ { name = "rss:feeddescription-<filename>"; value = "<description>"; } ]
The title of an RSS channel is specified with the
rss:feedtitle project_specific attribute:
project_specific = [ { name = "rss:feedtitle-<filename>"; value = "<title>"; } ]
The language of an RSS channel is specified with the
rss:feedlanguage project_specific attribute:
project_specific = [ { name = "rss:feedlanguage-<filename>"; value = "<language"; } ] OBSOLETE FIELDSThere are some obsolete fields in the file. They are provided for backwards compatibility only, and should not be used.
This field is used to difference 3 files. The command is
always executed by developers. Used by the aed(1) command. All of the
substitutions described by aesub(5) are available; in addition,
Executed as: the project owner (for integration diffs), or the developer (for development diffs). Current directory: the integration directory (for integration diffs), or the development directory (for development diffs). Exit status: zero indicates success, all non‐zero exits indicate failure (the aed will fail). The problem with this field was that the default usage placed the merged source in a strange place. And subsequent aed(1) commands would over‐write it. This meant that merges would be lost, causing a number of nasty problems. Some sites overcame this by adding “mv” commands to put the output back where the input came from, but this meant that Aegis' commentary was misleading. Use the “merge_command” field instead. It is almost identical, but Aegis will move the files around for you - so you get the good behavior by default (no lost merges) and the error message is consistent.
This flag is true if Aegis should create symlinks from
the development directory to the baseline for all files in the baseline not in
the development directory immediately before a development_build_command is
issued. Usually used to trick dumb DMTs into believing the development
directory contains an entire copy of the project, though sometimes the DMT is
smart enough, the tools it must work with are not. Symlinks in the development
directory which point to nonexistent files will be removed.
Defaults to false if not set.
This flag is true if Aegis should create symlinks from
the integration directory to the ancestral baseline for all files in the
ancestral not in the integration directory immediately before a build_command
is issued. Usually used to trick dumb DMTs into believing the integration
directory contains an entire copy of the project, though sometimes the DMT is
smart enough, the tools it must work with are not. Symlinks in the integration
directory which point to nonexistent files will be removed.
Defaults to the same value as create_symlinks_before_build if not set.
This flag is true if Aegis should remove symlinks which
point from the development directory to the baseline directory immediately
after a development_build_command is issued. Only consulted if the
create_symlinks_before_build field is true, for the purpose of
reversing the actions of the create_symlinks_before_build field.
Defaults to false if not set.
This flag is true if Aegis should remove symlinks which
point from the integration directory to the ancestral baseline directory
immediately after a build_command is issued. Only consulted if the
create_symlinks_before_integration_build field is true, for the purpose
of reversing the actions of the
create_symlinks_before_integration_build field.
Defaults to true if not set. This default is intentional. It is important that there are no symlinks in the (new) baseline, because they could go stale between integrations. If you set this field to false, caveat emptor. CHANGING HISTORY TOOLSince version Aegis 4.26 it is possible to change the history tool, if needed. Note, however, that the old tool is still required to retrieve file's revisions saved before the switch to the new tool. As an example it is not advisable to uninstall the fhist package if a project switched to aesvt, since fhist will be required to retrieve file's revisions pre-dating the switch.The aeipass(1) command stores the history_get_command as the aegis:history_get_command user defined change's attribute, that command will be used later to retrieve files altered by the change. In any project created using Aegis v. 4.26 (or later) it is possible to use a different history tool simply editing the appropriate aepconf(5) fields. It is possible to change the history tool of projects created with a older Aegis version, but it's required to properly set the aegis:history_get_command user defined attribute for each change integrated before the switch. SEE ALSO
COPYRIGHTaegis version 4.25.D510Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 Peter Miller 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
Visit the GSP FreeBSD Man Page Interface. |