Difference between revisions of "Autobuild"

From Second Life Wiki
Jump to navigation Jump to search
Line 16: Line 16:
from the top level directory of the working copy.  You may need administrative privilege on your system to install into system command directories.
from the top level directory of the working copy.  You may need administrative privilege on your system to install into system command directories.


== Autobuild Documentation ==  
== Running Autobuild ==  
Usage:
      <nowiki>autobuild [-v] [--help [HELP]] [--dry-run] [--quiet] [--verbose]</nowiki>
                <nowiki>[--debug]</nowiki>
               
                <nowiki>{installables,configure,package,edit,upload,manifest,build,install,print,source_environment,uninstall}</nowiki>
                <nowiki>...</nowiki>


There is, alas, not a comprehensive command reference for Autobuild here (yet - ''volunteers?''), but there is built-in help.  Autobuild has several subcommands; for a list of the subcommands and the global options, run:
Sub Commands:
autobuild --help
 
There is also more detailed help and a list of subcommand-specific options by using the --help option with any subcommand:
:;<nowiki>build</nowiki>
autobuild ''subcommand'' --help
::<nowiki>Builds platform targets.</nowiki>
:;<nowiki>configure</nowiki>
::<nowiki>Configures platform targets.</nowiki>
:;<nowiki>edit</nowiki>
::<nowiki>Manage build and package configuration.</nowiki>
:;<nowiki>install</nowiki>
::<nowiki>Fetch and install package archives.</nowiki>
:;<nowiki>installables</nowiki>
::<nowiki>Manipulate installable package entries in the autobuild configuration.</nowiki>
:;<nowiki>manifest</nowiki>
::<nowiki>Manipulate manifest entries to the autobuild configuration.</nowiki>
:;<nowiki>package</nowiki>
::<nowiki>Creates an archive of build output.</nowiki>
:;<nowiki>print</nowiki>
::<nowiki>Print configuration.</nowiki>
:;<nowiki>source_environment</nowiki>
::<nowiki>Prints out the shell environment Autobuild-based buildscripts to use (by calling 'eval').</nowiki>
:;<nowiki>uninstall</nowiki>
::<nowiki>Uninstall package archives.</nowiki>
:;<nowiki>upload</nowiki>
::<nowiki>upload tool for autobuild </nowiki>
 
Options:
:{|border="0" cellpadding="5" style="border-collapse: collapse; border-style: none;"
 
|- style="vertical-align: top;"
|<nowiki>-v, --version</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>--help&nbsp;[HELP]</nowiki>
|<nowiki>find all valid Autobuild Tools and show help</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>--dry-run</nowiki>
|<nowiki>run tool in dry run mode if available</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>--quiet</nowiki>
|<nowiki>minimal output</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>--verbose</nowiki>
|<nowiki>verbose output</nowiki>
 
|- style="vertical-align: top;"
|<nowiki>--debug</nowiki>
 
|}
 
===Background and Tutorials===


; [[Autobuild How To]]
; [[Autobuild How To]]

Revision as of 18:36, 13 February 2011

Autobuild is an in-house 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 actually configure and build your library. Autobuild will, however, allow you invoke these commands and package the product with a common interface. (for Linden old hands: Autobuild is designed as a replacement for the old lindenlib policies, doing the right thing so you don't have to.)

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

Getting Autobuild

Autobuild is available as a Mercurial repository: 

https://bitbucket.org/lindenlab/autobuild

Running Autobuild

You can either run the autobuild command directly from the "bin" directory in a working copy of that repository, or install it as a normal python package by running 

python setup.py install

from the top level directory of the working copy. You may need administrative privilege on your system to install into system command directories.

Running Autobuild

Usage: 

      autobuild [-v] [--help [HELP]] [--dry-run] [--quiet] [--verbose]
                [--debug]
                
                {installables,configure,package,edit,upload,manifest,build,install,print,source_environment,uninstall}
                ...

Sub Commands:

build
Builds platform targets.
configure
Configures 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
Creates an archive of build output.
print
Print configuration.
source_environment
Prints out the shell environment Autobuild-based buildscripts to use (by calling 'eval').
uninstall
Uninstall package archives.
upload
upload tool for autobuild

Options:

-v, --version
--help [HELP] find all valid Autobuild Tools and show help
--dry-run run tool in dry run mode if available
--quiet minimal output
--verbose verbose output
--debug

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 Package Examples

Contributing to Autobuild

Autobuild is open source. Improvements are most welcome.

Retrieved from "https://wiki.secondlife.com/w/index.php?title=Autobuild&oldid=1134220"