NAME [edit section]

= NAME =
build_error

SYNOPSIS [edit section]

= SYNOPSIS =
 * build_error ["<reason-string>"]

DESCRIPTION [edit section]

= DESCRIPTION =
This helper function touches the file "build_failed", then aborts the job
with the message: "Build failed: $@"

This function calls abort_job, and so does not return.

EXAMPLES [edit section]

= EXAMPLES =
Here are some sample invocations:
{{{#!YellowBox
    build_error "missing patch file: $1"
}}}

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
This function assumes that the current directory is the build directory.

RETURN [edit section]

= RETURN =
This function does not return.

SOURCE [edit section]

= SOURCE =
Located in ''scripts/functions.sh''

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_abort_job|abort_job]]