Difference between revisions of "Autobuild Shell Functions"
Jump to navigation
Jump to search
Nat Linden (talk | contribs) m (try <source lang="bash"> markup) |
Nat Linden (talk | contribs) m (Updated bitbucket source link to point to lindenlab/autobuild-1.0) |
||
| Line 5: | Line 5: | ||
<source lang="bash">eval "$("$AUTOBUILD" source_environment)"</source> | <source lang="bash">eval "$("$AUTOBUILD" source_environment)"</source> | ||
The exact shell code that is injected into your environment upon execution of this command [https://bitbucket.org/lindenlab/autobuild/src/tip/autobuild/autobuild_tool_source_environment.py is here]. | The exact shell code that is injected into your environment upon execution of this command [https://bitbucket.org/lindenlab/autobuild-1.0/src/tip/autobuild/autobuild_tool_source_environment.py?at=default#cl-161 is here], with (for Windows) additional functions [https://bitbucket.org/lindenlab/autobuild-1.0/src/tip/autobuild/autobuild_tool_source_environment.py?at=default#cl-250 here]. | ||
== General functions == | == General functions == | ||
Revision as of 11:25, 20 March 2015
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 |