Autobuild

Autobuild

• Building the Viewer
• Quick Start
• How To
• Glossary
• Examples
• Package Layout
• Class Model
• Build Script Anatomy
• Shell Functions

Warning: These instructions will not work with viewer-release because they are being updated to build the 64bit (Alex Ivy) repository; for instructions that will work on other repositories, use the history tab above to view the instructions from 15 Jun 2017. Be aware that upgrading the tools on your system to those described here will mean that you will not be able to build older versions of the viewer.

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.

Important: Linden Lab Autobuild is not the same as or derived from GNU Autobuild, but they are similar enough to cause confusion.

Note: This page and the rest of the autobuild documentation is in the process of being updated for the changes between autobuild 0.8 and autobuild 1.0 - if you are having difficulties, ask for help on the OpenSource-Dev mailing list.

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 2.7 for autobuild 1.1 (python version 2.6.6 may work for most subcommands, but will complain).

To install with the appropriate python package dependencies, use:

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

depending on how your permissions are defined and whether or not you are working within a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ python virtualenv], you may need to run that under the sudo command.

Important: Projects that have not yet upgraded to autobuild 1.1 will need the version of autobuild from https://bitbucket.org/lindenlab/autobuild or https://bitbucket.org/lindenlab/autobuild1.0 those versions are deprecated; users are strongly urged to move to version 1.1.

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.

• Discussion of and help with Autobuild are available on the opensource-dev mailing list and the #opensl channel on the freenode.org IRC network.
• Bug reports and feature suggestions are tracked in the Open Development project on jira.secondlife.com.
  • Testing procedures for patch submissions are documented here: Autobuild/Integration