Name

aegis -Make_Transparent — make branch file transparent

Synopsis

aegis -Make_Transparent [option...] filename...

aegis -List [option...]

aegis -Help

aegis -VERSion

DESCRIPTION

The aegis -Make_Transparent command is used to add a file to the change which will result in the named file being made transparent in the branch when the change is integrated. The version of the project file from the deeper branch will then show through.

You may name a directory to make all files in that directory tree transparent. It is an error if there are no relevant files.

Branch vs Change

The aecpu(1) command may only be applied to a change. If you wish to perform the same operation on a branch, use the aemt(1) command, through the agency of a change.

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

Process Side Effects

This command will cancel any build or test registrations, because changing the change file list logically invalidates them.

Notification

The make_transparent_command in the project configuration file is run, if set. The project_file_command is also run, if set, and if there has been an integration recently. See aepconf(5) for more information.

OPTIONS

The following options are understood:

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

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

-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 information. It is usually useful for shell scripts.

-UNChanged

Examine the named files to see if they are unchanged. Only remove the unchanged files from the branch, and leave the files which have changed. If no files are named on the command line all branch files are checked.

-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

The recommended alias for this command is



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

This command is dedicated to my wife, Mary-Therese. When I was trying to explain what this command did, she said "I had one of those on my bicycle when I was young, but it fell off".

ERRORS

It is an error if the change is not in the being developed state. It is an error if the change is not assigned to the current user. It is an error if the file is not present in the immediate branch. It is an error if the file is present in the immediate branch, but is not also present in a deeper branch. It is an error if the file is only present in the trunk branch.

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 aepconf(5) for the project configuration file's project_specific field for how to set environment variables for all commands executed by Aegis.

SEE ALSO

aecpu(1)

uncopy copy files from a change

aemtu(1)

cease making branch files transparent

COPYRIGHT

aegis version 4.22 Copyright (C) 1991-2006 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 MillerE-Mail:millerp@canb.auug.org.au
/\/\*WWW:http://www.canb.auug.org.au/~millerp/