Autobuild Shell Functions
Revision as of 12:37, 20 March 2015 by Nat Linden (talk | contribs) (add back the rest of the warning without <p/>)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Warning!
Some message here.
Autobuild offers a set of shell functions for use in build-cmd.sh scripts which can be added to the environment by inserting the following line into any build script:
eval "$("$AUTOBUILD" source_environment)"
The exact shell code that is injected into your environment upon execution of this command is here, with (for Windows) additional functions here.
General functions
Shell functions provided by autobuild:
| Function | Description |
|---|---|
| pass | Indicates build has succeeded |
| fail $comment | Indicates build has failed, citing $comment in the output |
| fetch_archive $url $archive $md5 | Uses curl to download $archive from the $url and checks the downloaded file hash against the $md5 provided. |
| extract $file | Extracts contents of an archive appropriate for the tar extension of $file. |
| calc_md5 $file | Calculate the md5 of $file |
Windows-only commands
Windows-only shell commands (Cygwin):
| Function | Description |
|---|---|
| build_vcproj $vcproj $config | Launches a Visual Studio build of $vcproj, building configuration $config.
If $USE_INCREDIBUILD is set, the same build is launched via BuildConsole, Incredibuild's command-line launcher. |
| build_sln $sln $config $project | Launches a Visual Studio build using the solution file $sln, configuration $config, and specifying project $project.
If $project is omitted, then the entire solution will be built. |
| load_vsvars | Import Visual Studio paths, includes and libs into the shell environment |