Autobuild Shell Functions - Revision history

Nat Linden: Update instructions about autobuild source_environment with AUTOBUILD vs. autobuild warning

2015-03-20T20:03:55Z

Update instructions about autobuild source_environment with AUTOBUILD vs. autobuild warning

← Older revision		Revision as of 13:03, 20 March 2015
Line 11:		Line 11:
	pip install hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild		pip install hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild

	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:		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 lines such as the following into your build script:
	<br clear=all/>		<br clear=all/>
	<source lang="bash">eval "$("$~~AUTOBUILD~~" source_environment)"</source>		<source lang="bash">
			if [ "$OSTYPE" == "cygwin" ]
			then autobuild="$(cygpath -u "$AUTOBUILD")"
			else autobuild="$AUTOBUILD"
			fi
			eval "$("$autobuild" source_environment)"
			</source>

			{{Warning\|The AUTOBUILD environment variable is passed through a number of different programs written in different languages. On Windows, it is essential that AUTOBUILD be a pathname in native syntax (e.g. <tt>c:\Users\Joe\autobuild.exe</tt> or <tt>c:/Users/Joe/autobuild.exe</tt>) rather than cygwin syntax (e.g. <tt>/cygdrive/c/Users/Joe/autobuild.exe</tt>).}}

			When invoking autobuild from within your <tt>build-cmd.sh</tt>, you must convert it to cygwin syntax so that cygwin bash doesn't get confused. However, it is '''essential''' to avoid overwriting the AUTOBUILD environment variable itself, or various child programs will, in turn, be confused. Capture the converted autobuild pathname in a ''different'' environment variable local to your script. Since bash environment variables are case-sensitive, it works to use <tt>autobuild</tt> for the cygwin-form path, leaving <tt>AUTOBUILD</tt> for the native-form path.

	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].		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].

Nat Linden: Apparently there's a maximum length to warning text? Extracted install suggestions to after warning.

2015-03-20T19:45:56Z

Apparently there's a maximum length to warning text? Extracted install suggestions to after warning.

← Older revision		Revision as of 12:45, 20 March 2015
Line 1:		Line 1:
	{{Autobuild Nav}}		{{Autobuild Nav}}

	{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.~~<br/>~~You can install autobuild 1.0 (e.g. into a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ virtualenv]) from the alternate repository using a command such as (bash):~~<br/><tt>~~pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild'~~</tt><br/>~~or (Windows command prompt):~~<br/>~~pip install hg+http//bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild}}		{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.}}

			You can install autobuild 1.0 (e.g. into a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ virtualenv]) from the alternate repository using a command such as (bash):

			pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild'

			or (Windows command prompt):

			pip install hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild

	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:		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:

Nat Linden: add back the rest of the warning without

2015-03-20T19:37:51Z

add back the rest of the warning without <p/>

← Older revision		Revision as of 12:37, 20 March 2015
Line 1:		Line 1:
	{{Autobuild Nav}}		{{Autobuild Nav}}

	{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.}}		{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.<br/>You can install autobuild 1.0 (e.g. into a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ virtualenv]) from the alternate repository using a command such as (bash):<br/><tt>pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild'</tt><br/>or (Windows command prompt):<br/>pip install hg+http//bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild}}

	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:		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:

Nat Linden: Try to improve formatting of version 1.0 warning

2015-03-20T19:36:42Z

Try to improve formatting of version 1.0 warning

← Older revision		Revision as of 12:36, 20 March 2015
Line 1:		Line 1:
	{{Autobuild Nav}}		{{Autobuild Nav}}

	{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.<p/>You can install autobuild 1.0 (e.g. into a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ virtualenv]) from the alternate repository using a command such as (bash):<br/><tt>pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild'</tt><br/>or (Windows command prompt):<br/>pip install hg+http//bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild}}		{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.}}

	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:		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:

Nat Linden: Add warning concerning autobuild 1.0 vs. 0.8

2015-03-20T19:34:52Z

Add warning concerning autobuild 1.0 vs. 0.8

← Older revision		Revision as of 12:34, 20 March 2015
Line 1:		Line 1:
	{{Autobuild Nav}}		{{Autobuild Nav}}

			{{Warning\|This page describes autobuild 1.0. As of 2015-03-20, autobuild 1.0 can be found in [https://bitbucket.org/lindenlab/autobuild-1.0/ this repository]; as of this date, [https://bitbucket.org/lindenlab/autobuild/ the official repository] and [https://pypi.python.org/pypi/autobuild the PyPI package] are still at autobuild 0.8.<p/>You can install autobuild 1.0 (e.g. into a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ virtualenv]) from the alternate repository using a command such as (bash):<br/><tt>pip install 'hg+http://bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild'</tt><br/>or (Windows command prompt):<br/>pip install hg+http//bitbucket.org/lindenlab/autobuild-1.0#egg=autobuild}}

	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:		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:

Nat Linden: Updated bitbucket source link to point to lindenlab/autobuild-1.0

2015-03-20T19:25:35Z

Updated bitbucket source link to point to lindenlab/autobuild-1.0

← Older revision		Revision as of 12:25, 20 March 2015
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 ==

Nat Linden: try markup

2015-03-19T22:05:53Z

try <source lang="bash"> markup

← Older revision		Revision as of 15:05, 19 March 2015
Line 3:		Line 3:
	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:		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/>		<br clear=all/>
	<~~syntaxhighlight~~ lang="bash">eval "$("$AUTOBUILD" source_environment)"</~~syntaxhighlight~~>		<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/src/tip/autobuild/autobuild_tool_source_environment.py is here].

Nat Linden: replaced nonfunctional ... markup with

2015-03-19T20:48:06Z

replaced nonfunctional <bash>...</bash> markup with <syntaxhighlighting lang="bash">

← Older revision		Revision as of 13:48, 19 March 2015
Line 3:		Line 3:
	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:		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/>		<br clear=all/>
	<bash>eval "$("$AUTOBUILD" source_environment)"</~~bash~~>		<syntaxhighlight lang="bash">eval "$("$AUTOBUILD" source_environment)"</syntaxhighlight>

	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].

Rand Linden: /* Windows-only commands */

2011-03-09T18:21:44Z

Windows-only commands

← Older revision		Revision as of 11:21, 9 March 2011
Line 43:		Line 43:
	! Description		! Description
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	\| build_vcproj $vcproj $config		\|width=200\| 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.		\| 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;"
	\| build_sln $sln $config $project		\| 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.		\| 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;"

Rand Linden at 19:49, 8 March 2011

2011-03-08T19:49:00Z

← Older revision		Revision as of 12:49, 8 March 2011
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]]