Difference between revisions of "Autobuild Shell Functions"

From Second Life Wiki
Jump to: navigation, search
m
Line 1: Line 1:
Autobuild offers a set of shell functions for use in <tt>build-cmd.sh</tt> scripts which can be added to the environment by inserting the following line into any build script:
+
{{Autobuild Nav}}
  
 +
Autobuild offers a set of shell functions for use in <code>build-cmd.sh</code> scripts which can be added to the environment by inserting the following line into any build script:
 +
<br clear=all/>
 
<bash>eval "$("$AUTOBUILD" source_environment)"</bash>
 
<bash>eval "$("$AUTOBUILD" source_environment)"</bash>
  
 
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/src/tip/autobuild/autobuild_tool_source_environment.py is here].
  
 +
== General functions ==
 
Shell functions provided by autobuild:
 
Shell functions provided by autobuild:
:{|border="0" cellpadding="5" style="border-collapse: collapse; border-style: none;"
+
{| border="1" class=lltable
 
+
|-
 +
! Function
 +
! Description
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>pass</nowiki>
+
| pass
|<nowiki>Indicates build has succeeded</nowiki>
+
| Indicates build has succeeded
  
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>fail $comment</nowiki>
+
| fail $comment
|<nowiki>Indicates build has failed, citing $comment in the output</nowiki>
+
| Indicates build has failed, citing $comment in the output
  
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>fetch_archive $url $archive $md5</nowiki>
+
| fetch_archive $url $archive $md5
|<nowiki>Uses curl to download $archive from the $url and checks the downloaded file hash against the $md5 provided.</nowiki>
+
| Uses curl to download $archive from the $url and checks the downloaded file hash against the $md5 provided.
  
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>extract $file</nowiki>
+
| extract $file
| <nowiki>Extracts contents of an archive appropriate for the tar extension of $file.</nowiki>
+
| Extracts contents of an archive appropriate for the tar extension of $file.
  
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>calc_md5 $file</nowiki>
+
| calc_md5 $file
|<nowiki>Calculate the md5 of $file</nowiki>
+
| Calculate the md5 of $file
  
 
|}
 
|}
  
 
+
== Windows-only commands ==
 
Windows-only shell commands (Cygwin):
 
Windows-only shell commands (Cygwin):
:{|border="0" cellpadding="5" style="border-collapse: collapse; border-style: none;"
 
  
 +
{| border="1" class=lltable
 +
|-
 +
! Function
 +
! Description
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>build_vcproj $vcproj $config</nowiki>
+
| build_vcproj $vcproj $config
|<nowiki>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.</nowiki>
+
| 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.
  
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>build_sln $sln $config $project</nowiki>
+
| build_sln $sln $config $project
|<nowiki>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.</nowiki>
+
| 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.
  
 
|- style="vertical-align: top;"
 
|- style="vertical-align: top;"
|<nowiki>load_vsvars</nowiki>
+
| load_vsvars
|<nowiki>Import Visual Studio paths, includes and libs into the shell environment</nowiki>
+
| Import Visual Studio paths, includes and libs into the shell environment
  
 
|}
 
|}
  
 
[[Category:Autobuild]]
 
[[Category:Autobuild]]

Revision as of 12:49, 8 March 2011


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:
<bash>eval "$("$AUTOBUILD" source_environment)"</bash>

The exact shell code that is injected into your environment upon execution of this command is 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