'\" tp .\" aegis - project change supervisor .\" Copyright (C) 1991-1994, 1997-1999, 2001, 2002, 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 .\" . .\" .\" .\" 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) -Develop_End" 1 \*(N) "Reference Manual" .SH NAME aegis develop end \- complete development of a change .XX "aede(1)" "complete development of a change" .SH SYNOPSIS .B \*(n) .B -Develop_End [ .IR option ... ] .br .B \*(n) .B -Develop_End .B -List [ .IR option ... ] .br .B \*(n) .B -Develop_End .B -Help .SH DESCRIPTION The .I \*(n) .I -Develop_End command is used to notify \*(n) of the completion of the development of a change. .PP This command checks that you have successfully completed an '\*(n) -Build' command since any change source file was edited. See .IR aeb (1) for more information. .PP This command checks that you have successfully completed an '\*(n) -DIFFerence' command since any change source file was edited. See .IR aed (1) for more information. .PP This command checks that you have successfully completed an '\*(n) -Test' command since the last successful build, unless the change has a .I test_exempt attribute, or the build command is \f[CW]"exit 0"\fP. This command checks that you have successfully completed an '\*(n) -Test -BaseLine' command, unless the change has a .I test_baseline_exempt attribute. This command checks that you have successfully completed an '\*(n) -Test -REGression' command, unless the change has a .I test_regression_exempt attribute. See .IR aet (1) and .IR aecattr (5) for more information. .PP If the change includes the project configuration file, this command checks project file names, to make sure they conform to the .I maximum_filename_length and .I posix_filename_charset field settings. See .IR aepconf (5) for more information. .PP Successful execution of the command advances the change from the .I "being developed" state to the .I "being reviewed" state, by default. The \fIdevelop_\%end_\%action\fP project attribute controls which of the following 3 paths are taken. .\" ------------------------------------------------------------------------ .PS boxwid = 1 down S30: box invis "\fIdevelop_end_action:\fP" "\fIgoto_awaiting_review\fP" S31: box "being" "developed" arrow " develop" ljust " end" ljust S32: box "awaiting" "review" arrow " review" ljust " begin" ljust S33: box "being" "reviewed" arrow " review" ljust " pass" ljust S34: box "awaiting" "integration" S20: box invis "\fIdevelop_end_action:\fP" "\fIgoto_being_reviewed\fP" \ with .w at S30.e+(0.5,0) S21: box "being" "developed" arrow " develop" ljust " end" ljust down 1.5 S22: box "being" "reviewed" arrow " review" ljust " pass" ljust S23: box "awaiting" "integration" box invis "\fI(This is the default.)\fP" S10: box invis "\fIdevelop_end_action:\fP" "\fIgoto_awaiting_integration\fP" \ with .w at S20.e+(0.5,0) S11: box "being" "developed" arrow " develop" ljust " end" ljust down 2.5 S12: box "awaiting" "integration" .PE .\" ------------------------------------------------------------------------ \fBPlease Note:\fP the third alternative, skipping reviews altogether, should only be used for single person projects. All self-respecting commercial enterprise will avoid this alternative. .PP Because branches may extend for many months or even years, it is common for the user who initiated the branch to be no longer with the project, or even the company. For this reason, project administrators may end the development of branches. For normal changes in this situation, use the .IR aechown (1) command. .PP If the project configuration file has specified the presence of \f[CW]Signed-off-by:\fP lines, a suitable line containing the current user's email address will be appended to the change description. .PP The change is no longer considered assigned to the developer. .SS Branches If you get an error message telling you that you can't end a branch because a file needs to be merged, see the Branching chapter of the Aegis User Guide for more information. .PP While changes and branches are almost identical in the ways you manipulate them within Aegis, actual file changes must always be done in a change. Thus, it is necessary to create a new change on the branch and do a cross-branch grandparent merge before you will be able to develop-end a branch which is giving you this error. .SS Notification On successful completion of the command, the \fIdevelop_\%end_\%notify_\%command\fP field of the project attributes file is run, if set. See \fIaepa\fP(1) and \fIaepattr\fP(5) for more information. .PP If your project has configured the \fIdevelop_\%end_\%action\fP in the project confifuration file to \fIgoto_\%awaiting_\%integration\fP then the \fIreview_\%pass_\%notify_\%command\fP in the project attributes file is run instead, if set. .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) 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) 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\-REAson\fP \fItext\fP 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. .\" .\" aegis - project change supervisor .\" Copyright (C) 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 .\" . .\" .TP 8n \fB\-Signed_Off_By\fP This option may be used to have a \f[CW]Signed-off-by:\fP line appended to the change set description. .TP 8n \fB\-No_Signed_Off_By\fP This option may be used to prevent a \f[CW]Signed-off-by:\fP line from being appended to the change set description. .\" .\" 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) 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) 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 aede '\*(n) -de \e!* -v' sh$ aede(){\*(n) -de "$@" -v} .fi .SH ERRORS It is an error if the change is not assigned to the current user. .br It is an error if The change is not in the .I "being developed" state. .br It is an error if there has been no successful .I "'\*(n) -Build'" command since a change file was last edited. .br It is an error if there has been no successful .I "'\*(n) -DIFFerence'" command since a change file was last edited. .br It is an error if there has been no successful .I "'\*(n) -Test'" command since a change file was last edited. .br It is an error if there has been no successful .I "'\*(n) -Test -BaseLine'" command since a change file was last edited. .PP It is an error if an read-only file is still copied into the change. Read-only files are to insulate a change from the baseline during development; they must be removed before development may end. .\" .\" 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 aeb (1) build a change .TP 8n .IR aeca (1) list or modify attributes of a change .TP 8n .IR aed (1) difference a change .TP 8n .IR aedb (1) begin development of a change .TP 8n .IR aede-policy (1) validate change set is ready to end .TP 8n .IR aedeu (1) recall a change for further development .TP 8n .IR aerfail (1) fail a change review .TP 8n .IR aerpass (1) pass a change review .TP 8n .IR aet (1) test a change .TP 8n .IR aepconf (5) project configuration file format .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