NAME [edit section]

= NAME =
unpack - unpack the test program source tarfile

SYNOPSIS [edit section]

= SYNOPSIS =
unpack [nostrip]

DESCRIPTION [edit section]

= DESCRIPTION =
The unpack function is used during the build phase, to extract the tar file
into the current directory

The following extensions are supported:
 * gz, tgz - compressed with gzip
 * bz2 - compressed with bzip2
 * tar - uncompressed

This is normally called by the function ''pre_build'', but can be used
directly by the base test script.  (Although there are no examples of this that
I'm aware of.)

EXAMPLES [edit section]

= EXAMPLES =

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
Environment variables used:
 * $tarball - has the filename of the test program source
   * this comes from the base test script
 * $TEST_HOME

Arguments:
 * $1 is optional and may have the word "nostrip" to indicate that leading path components won't be stripped

RETURN [edit section]

= RETURN =
Returns result of the 'tar' command

SOURCE [edit section]

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

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_pre_build|pre_build]]