'\" t .\" aegis - project change supervisor .\" Copyright (C) 2002, 2004, 2006-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 1997, 2006-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .ds n) aegis .ds N) Aegis .if n .nr )M 8n .if n .nr IN 8n .if n .nr )I 8n .if n .po 0 .hy 0 .if n .ad l .de r) .if !'\\*(R)'no' \{\ .PP See also .IR \*(n) (1) for options common to all \*(n) commands. .\} .. .de eB .RS .nf .ft CW .ta 8n 16n 24n 32n .. .de eE .ft P .fi .RE .. .TH "\*(n) -MoVe_file_Undo" 1 \*(N) "Reference Manual" .SH NAME aegis move file undo \- undo the rename a file as part of a change .XX "aemvu(1)" "undo the rename a file as part of a change" .SH SYNOPSIS .B \*(n) .B -MoVe_file_Undo [ .IR option ... ] .IR filename ... .br .B \*(n) .B -MoVe_file_Undo .B -List [ .IR option ... ] .br .B \*(n) .B -MoVe_file_Undo .B -Help .SH DESCRIPTION The .I \*(n) .I -MoVe_file_Undo command is used to reverse the effects of the .I \*(n) .I -MoVe_file command. You only need to name one half of the rename, the other half will be determined automatically. You may apply this command to whole directories. .PP The named files will be removed from the development directory, and removed from the list of files in the change. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 1999, 2002, 2006-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .SS File Name Interpretation The \*(n) program will attempt to determine the project file names from the file names given on the command line. All file names are stored within \*(n) 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. .PP The \fB-BAse_RElative\fP 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. .PP The \fIrelative_filename_preference\fP in the user configuration file may be used to modify this default behavior. See \fIaeuconf\fP(5) for more information. .SS Process Side Effects This command will cancel any build or test registrations, because adding another file logically invalidates them. .SS Notification The \fInew_\%file_\%undo_\%command\fP and \fIremove_\%file_\%undo_\%command\fP in the project \fIconfig\fP file are run, if set. The \fIproject_\%file_\%command\fP is also run, if set, and if there has been an integration recently. See \fIaepconf\fP(5) for more information. .\" .\" aegis - project change supervisor .\" Copyright (C) 1999, 2002, 2005-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .SH WHITEOUT Aegis provides you with what is often called a \[lq]view path\[rq] which indicates to development tools (compilers, build systems, \fIetc\fP) look first in the development directory, then in the branch baseline, and so on up to the trunk baseline. .PP The problem with view paths is that in order to remove files, you need some kind of "whiteout" to say \[lq]stop looking, it's been removed.\[rq] .PP When you user the \fIaerm\fP(1) or \fIaemv\fP(1) commands, this means "add information to this change which will remove the file from the baseline when this change is integrated". \fII.e.\fP while the change is in the \fIbeing developed\fP state, the file is only "removed" in the development directory \- it's still present in the baseline, and will be until the change is successfully integrated. .PP When you use the \fIaerm\fP(1) or \fIaemv\fP(1) commands, Aegis will create a 1K file to act as the whiteout. It's contents are rather ugly so that if you compile or include the "removed" file accidentally, you get a fatal error. This will remind you to remove obsolete references. .PP When the change in integrated, the removed file is \fInot\fP copied/linked from the baseline to the integration directory, and is \fInot\fP copied from the development directory. At this time it is physically gone (no whiteout). It is assumed that because of the error inducing whiteout all old references were found and fixed while the change was in the \fIbeing developed\fP state. .SS File Manifests When generating list of files to be compiled or linked, it is important that the file manifest be generated from information known by Aegis, rather than from the file system. This is for several reasons: .TP 4m (a) Aegis knows exactly what (source) files are where, whereas everything else is inferring Aegis' knowledge; and .TP 4m (b) looking in the file system is hard when the view path is longer that 2 directories (and Aegis' branching method can make it arbitrarily long); and .TP 4m (c) The whiteout files, and anything else left \[lq]lying around\[rq], will confuse any method which interrogates the file system. .PP The easiest way to use Aegis' file knowledge is with something like an \fIawk\fP(1) script processing the Aegis file lists. For example, you can do this with \fImake\fP(1) as follows: .RS .nf .ta 0.5i .ft CW # generate the file manifest manifest.make.inc: manifest.make.awk ( aegis -l cf -ter ; aegis -l pf -ter ) | \e awk -f manifest.make.awk > manifest.make.inc # now include the file manifest include manifest.make.inc .ft R .fi .RE Note: this would be inefficient of you did it once per directory, but there is nothing stopping you writing numerous assignments into the \fImanifest.make.inc\fP file, all in one pass. .PP It is possible to do the same thing with Aegis' report generator (see \fIaer\fP(1) for more information), but this is more involved than the \fIawk\fP(1) script. However, with the information "straight from the horse's mouth" as it were, it can also be much smarter. .PP This file manifest would become out-of-date without an interlock to Aegis' file operations commands. By using the \fIproject-file_command\fP and \fIchange_file_command\fP fields of the project \fIconfig\fP file (see \fIaepconf\fP(5) for more information), you can delete this file at strategic times. .RS .nf .ft CW /* run when the change file manifest is altered */ change_file_command = "rm -f manifest.make.inc"; /* run when the project file manifest is altered */ project_file_command = "rm -f manifest.make.inc"; .ft R .fi .RE The new file manifest will thus be re-built during the next \fIaeb\fP(1) command. .SS Options and Preferences There is a \fB\-No-WhiteOut\fP option, which may be used to suppress whiteout files when you use the \fIaerm\fP(1) and \fIaemv\fP(1) commands. There is a corresponding \fB\-WhiteOut\fP option, which is usually the default. .PP There is a \fIwhiteout_preference\fP field in the user preferences file (see \fIaeuconf\fP(5) for more information) if you want to set this option more permanently. .SS Whiteout File Templates The \fIwhiteout_template\fP field of the project \fIconfig\fP file may be used to produce language-specific error files. If no whiteout template entry matches, a very ugly 1KB file will be produced \- it should induce compiler errors for just about any language. .PP If you want a more human-readable error message, entries such as .RS .nf .ft CW whiteout_template = [ { pattern = [ "*.[ch]" ]; body = "#error This file has been removed."; } ]; .ft R .fi .RE can be very effective (this example assumes \fIgcc\fP(1) is being used). .PP If it is essential that \fIno\fP whiteout file be produced, say for C source files, you could use a whiteout template such as .RS .nf .ft CW whiteout_template = [ { pattern = [ "*.c" ]; } ]; .ft R .fi .RE because an absent \fIbody\fP sub-field means generate no whiteout file at all. .PP You may have more than one whiteout template entry, but note that the order of the entries is important. The first entry which matches will be used. .SS Notification On successful completion of this command, the notifications usually performed by the \fIaermu\fP(1), \fIaenfu\fP(1) and \fIaentu\fP(1) commands are run, as appropriate. These include the \fIproject_\%file_\%command\fP, \fInew_\%file_\%undo_\%command\fP, \fInew_\%test_\%undo_\%command\fP and \fIremove_\%file_\%undo_\%command\fP fields of the project \fIconfig\fP file. See \fIaepconf\fP(5) for more information. .SH OPTIONS The following options are understood: .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2003, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n \fB-Change\fP \fInumber\fP This option may be used to specify a particular change within a project. See \fIaegis\fP(1) for a complete description of this option. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n .B -Help .br This option may be used to obtain more information about how to use the .I \*(n) program. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n .B -List .br This option may be used to obtain a list of suitable subjects for this command. The list may be more general than expected. .\" .\" aegis - project change supervisor .\" Copyright (C) 1992, 1993, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n .B -Not_Logging .br This option may be used to disable the automatic logging of output and errors to a file. This is often useful when several \*(n) commands are combined in a shell script. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n \fB-Project\fP \fIname\fP This option may be used to select the project of interest. When no .B -Project option is specified, the .I AEGIS_PROJECT environment variable is consulted. If that does not exist, the user's .I $HOME/.aegisrc file is examined for a default project field (see .IR 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. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n .B -TERse .br This option may be used to cause listings to produce the bare minimum of information. It is usually useful for shell scripts. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2002, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n .B -Verbose This option may be used to cause \*(n) to produce more output. By default \*(n) only produces output on errors. When used with the .B -List option this option causes column headings to be added. .\" .\" aegis - project change supervisor .\" Copyright (C) 2004-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n \fB\-Verify_Symbolic_Links\fP This option may be used to request that the symbolic links, or hard links, or file copies, in the work area be updated to reflect the current state of the baseline. This is controlled by the \fIdevelopment_\%directory_\%style\fP field of the project configuration file. Only files which are not involved in the change are updated. See also the \[lq]symbolic_links_preference\[rq] field of \fIaeuconf\fP(5). This option is the default, if meaningful for your configuration. The name is an historical accident, hard links and file copies are included. .TP 8n \fB\-Assume_Symbolic_Links\fP This option may be used to request that no update of baseline mirror files take place. This options is useful when you \fIdefinitely know\fP the files' up-to-date-ness isn't important right now; incorrect use of this option may have unanticipated build side-effects. See also the \[lq]symbolic_links_preference\[rq] field of \fIaeuconf\fP(5). This option is the default, if not meaningful for your configuration. The name is an historical accident, hard links and file copies are included. .\" .\" aegis - project change supervisor .\" Copyright (C) 1998, 2006-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n .B \-Wait This option may be used to require \*(N) commands to wait for access locks, if they cannot be obtained immediately. Defaults to the user's .I lock_wait_preference if not specified, see .IR aeuconf (5) for more information. .TP 8n .B \-No_Wait This option may be used to require \*(N) commands to emit a fatal error if access locks cannot be obtained immediately. Defaults to the user's .I lock_wait_preference if not specified, see .IR aeuconf (5) for more information. .\" .\" aegis - project change supervisor .\" Copyright (C) 1999, 2005-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .TP 8n \fB\-WhiteOut\fP This option may be used to request that deleted files be replaced by a \[lq]whiteout\[rq] file in the development directory. The idea is that compiling such a file will result in a fatal error, in order that all references may be found. This is usually the default. .TP 8n \fB\-No_WhiteOut\fP This option may be used to request that no \[lq]whiteout\[rq] file be placed in the development directory. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 2006-2008 Peter Miller. .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .r) .PP 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. .PP All options are case insensitive, you may type them in upper case or lower case or a combination of both, case is not important. .PP For example: the arguments "-project, "-PROJ" and "-p" are all interpreted to mean the \fB-Project\fP option. The argument "-prj" will not be understood, because consecutive optional characters were not supplied. .PP Options and other command line arguments may be mixed arbitrarily on the command line, after the function selectors. .br .ne 4 .PP The GNU long option names are understood. Since all option names for .I \*(n) are long, this means ignoring the extra leading '-'. The "\fB--\fIoption\fB=\fIvalue\fR" convention is also understood. .SH RECOMMENDED ALIAS The recommended alias for this command is .nf .ta 8n 16n csh% alias aemvu '\*(n) -mvu \e!* -v' sh$ aemvu(){\*(n) -mvu "$@" -v} .fi .SH ERRORS It is an error if the change is not in the .I "being developed" state. .br It is an error if the change is not assigned to the current user. .br It is an error if the file is not being moved by the change. .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1993, 1995, 1997, 2004, 2006-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .SH EXIT STATUS The .I \*(n) command will exit with a status of 1 on any error. The .I \*(n) command will only exit with a status of 0 if there are no errors. .SH ENVIRONMENT VARIABLES See \fIaegis\fP(1) for a list of environment variables which may affect this command. See \fIaepconf\fP(5) for the project configuration file's \fIproject_\%specific\fP field for how to set environment variables for all commands executed by Aegis. .br .ne 1i .SH SEE ALSO .TP 8n .IR aecp (1) copy files into a change .TP 8n .IR aedb (1) begin development of a change .TP 8n .IR aemv (1) rename files as part of a change .TP 8n .IR aenf (1) add files to be created by a change .TP 8n .IR aenfu (1) remove files to be created by a change .TP 8n .IR aerm (1) add files to be deleted by a change .TP 8n .IR aermu (1) remove files to be deleted by a change .TP 8n .IR aeuconf (5) user configuration file format .\" .\" aegis - project change supervisor .\" Copyright (C) 1991-1995, 1997, 2006-2008 Peter Miller .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see .\" . .\" .br .ne 2i .SH COPYRIGHT .ds v) 4.24.3 .ds V) 4.24.3.D001 .ds o) 0 .ds p) 4.25 .ds u) 4.24 .ds Y) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 \*(n) version \*(V) .br .if t .ds C) \(co .if n .ds C) (C) Copyright \*(C) \*(Y) Peter Miller .PP The \*(n) program comes with ABSOLUTELY NO WARRANTY; for details use the '\fI\*(n) -VERSion License\fP' command. This is free software and you are welcome to redistribute it under certain conditions; for details use the '\fI\*(n) -VERSion License\fP' command. .br .ne 1i .SH AUTHOR .TS tab(;); l r l. Peter Miller;E-Mail:;millerp@canb.auug.org.au \f(CW/\e/\e*\fR;WWW:;http://www.canb.auug.org.au/~millerp/ .TE