Difference between revisions of "Autobuild"

From Second Life Wiki
Jump to navigation Jump to search
(Update instructions for python 3 / autobuild 3)
 
(19 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Autobuild Nav}}
{{Autobuild Nav}}
__NOTOC__


== Overview ==
Autobuild is a framework for building packages and for managing the dependencies of a package on other packages. It provides a common interface to configuring and building any package, but it is not a build system like make or cmake. You will still need platform-specific make, cmake, or project files to configure and build your library. Autobuild will, however, allow you invoke these commands and package the product with a common interface.
Autobuild is a framework for maintaining and building libraries. It acts as director providing a common interface to build and package libraries, but it is not a build system like make or cmake. You will still need platform-specific make, cmake, or project files to configure and build your library. Autobuild will, however, allow you invoke these commands and package the product with a common interface.  


{{KBcaution|Linden Lab Autobuild is not the same as or derived from [http://josefsson.org/autobuild/ GNU Autobuild], but they are similar enough to cause confusion.}}


For Linden old hands: Autobuild is designed as a replacement for the old [https://svn.lindenlab.com/svn/lindenlib/trunk lindenlib] policies; doing the right thing so you don't have to.
__TOC__


== Getting Autobuild ==


Autobuild is available as a PyPI package:
'''Linden Lab Autobuild is not the same as or derived from [http://josefsson.org/autobuild/ GNU Autobuild], but they are similar enough to cause confusion. We regret this error.'''


[http://pypi.python.org/pypi/setuptools easy_install] autobuild
== Getting Autobuild ==
 
or
 
[http://pypi.python.org/pypi/pip pip] install autobuild
 
of if you don't have pip or easy_install
 
hg clone http://hg.secondlife.com/autobuild
cd autobuild
python setup.py install
 
You may need administrative privilege on your system to install into system command directories.


{{KBnote|If you are using Cygwin on Windows, you must also add your Python scripts directory (for example <code>C:/Program Files/python27/Scripts</code>) to your PATH. If you have further problems, please see [[Autobuild/Cygwin]]}}
Autobuild is under active development, so it's recommended that you get the latest version and keep it up to date.


{{KBtip|If you do not have administrative privilege on your system, or for any reason you wish to avoid adding autobuild into system-level Python or command directories, you can use [http://www.virtualenv.org/en/latest/index.html virtualenv], e.g.:
You should use Python 3.7+ for autobuild 3.x.


mkdir ~/virtualenvs  # or any directory for your Python-package environments
To install with the appropriate python package dependencies, use:
  VENV{{=}}~/virtualenvs/autobuild
  pip install 'git+https://bitbucket.org/lindenlab/autobuild.git@v3'
virtualenv "$VENV"
depending on how your permissions are defined and whether or not you
. "$VENV/bin/activate"
are working within a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ python virtualenv],
 
you may need to run that under the <tt>sudo</tt> command.
Then your <code>pip install autobuild</code> command will install autobuild under <code>$VENV</code> instead of into system directories. (Note that this <code>pip install</code> command will work either way. If you have an active virtualenv, it will install into the virtualenv; if not it will attempt to install into system directories.)
}} <!-- end pip/virtualenv tip -->


== Running Autobuild ==  
== Running Autobuild ==  
Line 42: Line 26:
=== Building the Viewer ===
=== Building the Viewer ===


See: [[Build_Viewer_With_Autobuild]]
See [[Building the Viewer with Autobuild]]


=== Changing or Adding Build Configuration Details ===
=== Changing or Adding Build Configuration Details ===
Line 59: Line 43:


|--
|--
| --debug
| --verbose
| Display debug information
| Display verbose output. Useful in diagnosing errors in your configuration.


|--
|--
| --dry-run
| --dry-run
| Run tool in dry run mode if available
| Run tool in dry run mode.  ''This mode will print information about what would have been done. It is supported for most subcommands.''


|--
|--
Line 75: Line 59:


|--
|--
| --verbose
| -V, --version
| Display verbose output
| Show version information for autobuild


|--
|--
| -V, --version
| --debug
| Show version information
| Display debug information; very very verbose, probably of interest only if you are modifying autobuild itself


|}
|}
Line 119: Line 103:
| [[autobuild uninstall|uninstall]]
| [[autobuild uninstall|uninstall]]
| Uninstall package archives.
| Uninstall package archives.
|--
| [[autobuild upload|upload]]
| Upload tool for autobuild
|}
|}


Line 149: Line 130:
* Discussion of and help with Autobuild are available on the [https://lists.secondlife.com/cgi-bin/mailman/listinfo/opensource-dev opensource-dev mailing list] and the [irc://irc.freenode.org/%23opensl #opensl channel on the freenode.org IRC network].
* Discussion of and help with Autobuild are available on the [https://lists.secondlife.com/cgi-bin/mailman/listinfo/opensource-dev opensource-dev mailing list] and the [irc://irc.freenode.org/%23opensl #opensl channel on the freenode.org IRC network].
* Bug reports and feature suggestions are tracked in the [https://jira.secondlife.com/browse/OPEN Open Development project on jira.secondlife.com].
* Bug reports and feature suggestions are tracked in the [https://jira.secondlife.com/browse/OPEN Open Development project on jira.secondlife.com].
** Suggested patches for issues from the jira are reviewed on our [https://codereview.secondlife.com code review system] (see [[Code Review Tool|the documentation on how to use it]]).
** Testing procedures for patch submissions are documented here: [[Autobuild/Integration]]
** Testing procedures for patch submissions are documented here: [[Autobuild/Integration]]


[[Category:Autobuild]] [[Category:Open Source Portal]]
[[Category:Autobuild]] [[Category:Open Source Portal]]

Latest revision as of 21:45, 1 March 2022



Autobuild is a framework for building packages and for managing the dependencies of a package on other packages. It provides a common interface to configuring and building any package, but it is not a build system like make or cmake. You will still need platform-specific make, cmake, or project files to configure and build your library. Autobuild will, however, allow you invoke these commands and package the product with a common interface.



Linden Lab Autobuild is not the same as or derived from GNU Autobuild, but they are similar enough to cause confusion. We regret this error.

Getting Autobuild

Autobuild is under active development, so it's recommended that you get the latest version and keep it up to date.

You should use Python 3.7+ for autobuild 3.x.

To install with the appropriate python package dependencies, use:

pip install 'git+https://bitbucket.org/lindenlab/autobuild.git@v3'

depending on how your permissions are defined and whether or not you are working within a python virtualenv, you may need to run that under the sudo command.

Running Autobuild

Building the Viewer

See Building the Viewer with Autobuild

Changing or Adding Build Configuration Details

Usage:

autobuild options sub-command

Supply zero or more options, and one sub-command.

Options:

Option Description
--verbose Display verbose output. Useful in diagnosing errors in your configuration.
--dry-run Run tool in dry run mode. This mode will print information about what would have been done. It is supported for most subcommands.
--help [command] Find all valid Autobuild tools and show help
--quiet Display minimal output
-V, --version Show version information for autobuild
--debug Display debug information; very very verbose, probably of interest only if you are modifying autobuild itself

Sub-commands

Sub-command Description
build Build platform targets.
configure Configure platform targets.
edit Manage build and package configuration.
install Fetch and install package archives.
installables Manipulate installable package entries in the autobuild configuration.
manifest Manipulate manifest entries to the autobuild configuration.
package Create an archive of build output.
print Print configuration.
source_environment Print the shell environment Autobuild-based build scripts to use (by calling 'eval').
uninstall Uninstall package archives.

Background and Tutorials

Autobuild How To
A tutorial introduction to using autobuild
Autobuild Lexicon
A list of terms and how they are used in the context of autobuild
Autobuild Package Layout
Describes the standard directory tree for packages managed with autobuild
Autobuild Quick Start
A basic walkthrough of how to add autobuild management to an existing software project
Autobuild Class Model
Describes the fundamental objects in the autobuild design and the relationships between them.
Autobuild Examples
Links to packages built with autobuild.
Build Script Anatomy
An annotated build script typical of those used to build third party libraries.
Autobuild Shell Functions
A description of all shell functions provided by Autobuild for use in build scripts.

Contributing to Autobuild

Autobuild is open source. Improvements are most welcome.