aegis -Develop_Begin

NAME

SYNOPSIS

DESCRIPTION

The development directory for the change will be created automatically; below the directory specified in the default_development_directory field of aeuconf(5), or if not set below the directory specified in the default_development_directory field of aepattr(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 aecd(1) command can take you there at any time.

Successful execution of this command will move the specified change from the awaiting development state to the being developed state. boxwid = 1 down S1: box "awaiting" "development" arrow " develop" ljust " begin" ljust S2: box "being" "developed" T1: spline -> from S2.w then left 0.75 then up 11/12    then to 1/3<S1.sw,S1.nw>
" develop" ljust " begin" ljust " undo" ljust at T1.c - (0.75,0)  

Notification

Development Directory Location

If your development directories (or your whole project) is on filesystems 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 config 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 dos_filename_required = true, and also changing the development_directory_template field. Heterogeneous development with various Windows environments may also require this.  

ADMINISTRATOR OVERRIDE

Warning: capricious use of this command will rapidly alienate developers. The defaulting rules, particularly for the change number, depend on aegis and the developer agreeing on what the developer is currently working on.

The forced_develop_begin_notify_command project attribute (see aepattr(5) for more information) will be run when an administrator uses the -User 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";

SYMBOLIC LINKS

Project Configuration

By using a setting such as

development_directory_style =
{
    source_file_symlink = true;
    during_build_only = true;
};

By using a setting such as

development_directory_style =
{
    source_file_symlink = true;
};

When files are copied from the baseline into a change, using the aecp(1) command, the symbolic link pointing into the baseline, if any, will be removed before the file is copied.

Note: Using this functionality in either form has implications for how the rules file of the dependency maintenance tool is written. Rules must remove their targets before creating them (usually with an rm -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 link_integration_directory field of the project configuration file.  

User Configuration

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 aedb(1) command does not 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 aeb(1) action is to ignore the user preference and the verify symbolic links.

There are two command line options which modify aeb(1) behavior further: the -Verify-Symbolic-Links option says to verify the symbolic links; and the -Assume-Symbolic-Links option says to assume the symbolic 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;
};

The symbolic link command line options and preferences apply equally to hard links and file copies (the names have historical origins).  

OPTIONS

-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.

-DIRectory path

This option may be used to specify which directory is to be used. It is an error if the current user does not have appropriate 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.

-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.

-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.

-REAson text

This option may be used to attach a comment to the change history generated by this command. You will need to use quotes to insulate the spaces from the shell.

-TERse

This option may be used to cause listings to produce the bare minimum of information. It is usually useful for shell scripts.

-User name

This option is used to specify the user who is to develop the change. This option may only be used by a project administrator.

-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) 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) 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 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

csh%    alias aedb 'aegis -db \!* -v'
sh$     aedb(){aegis -db "$@" -v}

ERRORS

EXIT STATUS

ENVIRONMENT VARIABLES

SEE ALSO

aeb(1)

build a change

aecd(1)

change directory

aecp(1)

copy files into a change

aed(1)

find differences between a change and the baseline

aedbu(1)

undo the effects of aedb

aede(1)

complete development of a change

aemv(1)

rename a file as part of a change

aenc(1)

add a new change to a project

aend(1)

add a new developer to a project

aenf(1)

add new files to a change

aent(1)

add a new test to a change

aepa(1)

modify the attributes of a project

aerm(1)

add files to be deleted to a change

aet(1)

run tests

aepattr(5)

project attributes file format

aeuconf(5)

user configuration file format

COPYRIGHT

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

Index

NAME

SYNOPSIS

DESCRIPTION

Notification

Development Directory Location

ADMINISTRATOR OVERRIDE

SYMBOLIC LINKS

Project Configuration

User Configuration

OPTIONS

RECOMMENDED ALIAS

ERRORS

EXIT STATUS

ENVIRONMENT VARIABLES

SEE ALSO

COPYRIGHT

AUTHOR