SIMPLE SOLUTIONS

AEGIS CLEAN - reference manual online

Clean files from development directory.

Chapter
*(N)
aegis -CLEan(1)                                                                   aegis -CLEan(1)

NAME aegis clEan - clean files from development directory
SYNOPSIS aegis -CLEan [ option... ] aegis -CLEan -Help aegis -VERSion
DESCRIPTION The aegis -CLEan command is used to remove all files which are not change source files from a development directory. This can be used to obtain a “clean” development directory before a final build, to ensure that a change is ready to end development. A new build will be required. This command is only allowed in the “being developed” state, and only the change's devel‐ oper may issue it. It may not be applied to branches. All symbolic links will be removed from the development directory, even if remove_‐ symlinks_after_build = false in the project config file. The symbolic links will be re- installed, if create_symlinks_before_build = true. This is to ensure that the symlinks are accurate, and that unnecessary ones are removed. All special device files, pipes and sockets will be removed. These files cannot be source files, and it is expected that the following build will restore them. All derived files created by previous builds of the change will be removed. It is expected that the following build will recreate them. Any temporary files you may have created in the development directory will also be removed. The develop_begin_command in the project configuration file (see aepconf(5) for more information) will be run, if there is one. The change_file_command will be run, if there is one. The project_file_command will be run, if there is one. You will be warned if any of the files are out-of-date and need to be merged. You will be warned if any files need to be differenced.
OPTIONS The following options are understood: -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. -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. -TOuch This option may be used to request that each change source file have its last- modified time-stamp be updated to the current time. This is the default. Derived files and other non-source file are left alone. -No_TOuch This option may be used to request that the last-modified time-stamp of each source file be left unmodified. -MINIMum This option may be used to request a minimum set of symbolic links, when the cre‐ ate_symlinks_to_baseline functions are being used. This is useful if you want to simulate something like aeib -minimum in the development directory. This option is not meaningful if symbolic links are not being used. This option also says not to remove normal files which occlude project source files. This is a common technique used to temporarily over-ride project source files. The “aecp -read-only” command would have been more appropriate. -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. -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_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.
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.
AUTHOR Peter Miller E-Mail: @canb.auug.org.au /\/\* WWW: http://www.canb.auug.org.au/~millerp/
Reference Manual Aegis aegis -CLEan(1)
This manual Reference Other manuals
aeclean(1) referred by
refer to aeb(1) | aecp(1) | aedb(1) | aegis(1) | aenf(1) | aent(1) | aepconf(5) | aerm(1) | aeuconf(5) | conf(5)