Provided by: aegis_4.24.3-3_amd64 bug

NAME

        aegis integrate fail - fail a change integration

SYNOPSIS

        aegis -Integrate_Fail -File reason-file [ option...  ]
        aegis -Integrate_Fail -REASon 'reason-text' [ option...  ]
        aegis -Integrate_Fail -Edit [ option...  ]
        aegis -Integrate_Fail -List [ option...  ]
        aegis -Integrate_Fail -Help

DESCRIPTION

        The aegis -Integrate_Fail command is used to inform aegis that a change has failed
        integration.

        The change will be returned from the being integrated state to the being developed state.
        The change will cease to be assigned to the current user, and will be reassigned to the
        originating developer.  The integration directory will be deleted.  boxwid = 1 down S2:
        box "being" "developed" arrow " develop" ljust " end" ljust box "awaiting" "review" arrow
        " review" ljust " begin" ljust box "being" "reviewed" arrow " review" ljust " pass" ljust
        box "awaiting" "integration" arrow " integrate" ljust " begin" ljust S5: box "being"
        "integrated"

        T7: spline -> from S5.e then right 0.5 then up 4 then to S2.e "integrate " rjust "fail "
        rjust at T7.c + (0.5,0)

        The reviewer and the developer will be notified by mail.  See the
        integrate_fail_notify_command in aepconf(5) for more information.

        The reason-file will contain a description of why the change was failed.  The file is in
        plain text.  It is recommended that you only use newline to terminate paragraphs, (rather
        than to terminate lines) as with will result in better formatting in the various
        listings.

   Notification
        On successful completion of this command, the integrate_fail_notify_command field of the
        project attributes is run, if set.  See aepattr(5) and aepa(1) for more information.

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.

        -Edit
                Edit the attributes with a text editor, this is usually more convenient than
                supplying a text file.  The VISUAL and then EDITOR environment variables are
                consulted for the name of the editor to use; defaults to vi(1) if neither is set.
                See the visual_command and editor_command fields in aeuconf(1) for how to
                override this specifically for Aegis.

                Warning: Aegis tries to be well behaved when faced with errors, so the temporary
                file is left in your home directory where you can edit it further and re-use it
                with a -file option.

                The -edit option may not be used in the background, or when the standard input is
                not a terminal.

        -Edit_BackGround
                Edit the attributes with a dumb text editor, this is most often desired when edit
                commands are being piped into the editor via the standard input.  Only the EDITOR
                environment variable is consulted for the name of the editor to use; it is a
                fatal error if it is not set.  See the editor_command field in aeuconf(1) for how
                to override this specifically for Aegis.

        -File filename
                Take the attributes from the specified file.  The filename `-' is understood to
                mean the standard input.

        -Help
                This option may be used to obtain more information about how to use the aegis
                program.

        -Keep
                This option may be used to retain files and/or directories usually deleted or
                replaced by the command.  Defaults to the user's delete_file_preference if not
                specified, see aeuconf(5) for more information.

        -No_Keep
                This option may be used to ensure that the files and/or directories are deleted
                or replaced by the command.  Defaults to the user's delete_file_preference if not
                specified, see aeuconf(5) for more information.

        -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 provide the failure reason on the command line, rather
                than in a file.  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.

        -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 aeifail 'aegis -ifail \!* -v'
        sh$     aeifail(){aegis -ifail "$@" -v}

ERRORS

        It is an error if the change is not in the being integrated state.
        It is an error if the change is not assigned to the current user.

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

        aeib(1) begin integration of a change

        aeipass(1)
                pass integration of a change

        aeuconf(5)
                user configuration file format

COPYRIGHT

        aegis version 4.24.3.D001
        Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
        2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Peter Miller

        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 Miller   E-Mail:   millerp@canb.auug.org.au
        /\/\*             WWW:   http://www.canb.auug.org.au/~millerp/