Difference between revisions of "Autobuild install"

From Second Life Wiki
Jump to navigation Jump to search
(Created page with "<!-- ======================================================================= This wiki page was generated by the converting the --help output from this command using the pyhelp2w…")
 
m
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- =======================================================================
{{Autobuild Cmd
This wiki page was generated by the converting the --help output from this
|command=
command using the pyhelp2wiki command.
autobuild install <br>    ''option'' [''value''] [''option'' [''value'']] ... <br>    [''package'' [''package'' ...]]
|comments=Installs artifacts of dependency packages for use during the build of the current package.


Rather than changing this page directly, or at least after having done so,  
'''Argument''':
consider making the change to the command help itself (or suggest doing so
* ''package'': name of package to consider for installation. 
to the author).
You may specify one or more packages, separated by a space; or none. If no packages are named, autobuild will attempt to install all packages listed in the 'installables' section of the configuration file.
======================================================================== -->
Usage:
      <nowiki>autobuild install [-h] [--config-file INSTALL_FILENAME]</nowiki>
                        <nowiki>[--installed-manifest INSTALLED_FILENAME]</nowiki>
                        <nowiki>[-p PLATFORM] [--install-dir INSTALL_DIR] [--list]</nowiki>
                        <nowiki>[--list-installed] [--skip-license-check]</nowiki>
                        <nowiki>[--list-licenses] [--export-manifest]</nowiki>
                        <nowiki>[--as-source AS_SOURCE] [-n] [-q] [-v] [-d]</nowiki>
                        <nowiki>[package [package ...]]</nowiki>


'''Private Packages''':


Arguments:
If a package has been marked as requiring GitHub or GitLab credentials environment variables need to be provided with
valid personal access tokens:


:;<nowiki>package</nowiki>
* <code>AUTOBUILD_GITHUB_TOKEN</code>
::<nowiki>List of packages to consider for installation. </nowiki>
* <code>AUTOBUILD_GITLAB_TOKEN</code>
}}


Options:
'''Command-Specific Options'''
:{|border="0" cellpadding="5" style="border-collapse: collapse; border-style: none;"
{| class=lltable border=1
|--
!width=180| Option
!width=70| Shortcut
!Value
!Description


|- style="vertical-align: top;"
|-  
|<nowiki>-h, --help</nowiki>
| --config-file ''filename''
|<nowiki>show this help message and exit</nowiki>
| N/A
| File that describes what is installed (defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml").
| Use specified configuration file.


|- style="vertical-align: top;"
|-  
|<nowiki>--config-file&nbsp;INSTALL_FILENAME</nowiki>
| --export-manifest
| <nowiki>The file used to describe what should be installed (defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml").</nowiki>
| N/A
| None
|Print the install manifest to stdout and exit.


|- style="vertical-align: top;"
|-  
|<nowiki>--installed-manifest&nbsp;INSTALLED_FILENAME</nowiki>
| --installed-manifest ''filename''
| <nowiki>The file used to record what is installed.</nowiki>
| N/A
| The file used to record what is installed.
| Save record of what is installed to the specified file.


|- style="vertical-align: top;"
|-  
|<nowiki>-p&nbsp;PLATFORM, --platform&nbsp;PLATFORM</nowiki>
| --install-dir ''dir''
| <nowiki>Override the automatically determined platform.</nowiki>
| N/A
| Directory path.
| Unpack installed files in specified directory


|- style="vertical-align: top;"
|-  
|<nowiki>--install-dir&nbsp;INSTALL_DIR</nowiki>
| --list
| <nowiki>Where to unpack the installed files.</nowiki>
| N/A
| None
|List the archives specified in the package file.


|- style="vertical-align: top;"
|-  
|<nowiki>--list</nowiki>
| --list-installed
|<nowiki>List the archives specified in the package file.</nowiki>
| N/A
| None
|List the installed package names and exit.


|- style="vertical-align: top;"
|-  
|<nowiki>--list-installed</nowiki>
| --list-licenses
|<nowiki>List the installed package names and exit.</nowiki>
| N/A
| None
|List known licenses and exit.


|- style="vertical-align: top;"
|-  
|<nowiki>--skip-license-check</nowiki>
| --platform ''platform''
|<nowiki>Do not perform the license check.</nowiki>
| -p ''platform''
| Platform name
| Override the automatically determined platform.
|-
| --list-install-urls
|
|
|Lists the archive urls for all installed packages


|- style="vertical-align: top;"
|<nowiki>--list-licenses</nowiki>
|<nowiki>List known licenses and exit.</nowiki>


|- style="vertical-align: top;"
|-
|<nowiki>--export-manifest</nowiki>
| --list-dirty
|<nowiki>Print the install manifest to stdout and exit.</nowiki>
|
|
|Lists the names of 'dirty' installed packages


|- style="vertical-align: top;"
|<nowiki>--as-source&nbsp;AS_SOURCE</nowiki>
| <nowiki>Get the source for this package instead of prebuilt binary.</nowiki>


|- style="vertical-align: top;"
|-
|<nowiki>-n, --dry-run</nowiki>
| --what-installed ''file-path''
|<nowiki>run tool in dry run mode if available</nowiki>
|
| path to a file installed by some package
| Lists the archive responsible for installing the specified file; useful when finding conflicts between packages


|- style="vertical-align: top;"
|-
|<nowiki>-q, --quiet</nowiki>
| --versions
|<nowiki>minimal output</nowiki>
|
|
|Prints each package name and its version value


|- style="vertical-align: top;"
|-
|<nowiki>-v, --verbose</nowiki>
| --copyrights
|<nowiki>verbose output</nowiki>
|
|
|Prints each package name and its copyright value


|- style="vertical-align: top;"
|-
|<nowiki>-d, --debug</nowiki>
| --local ''archive''
|
| path to an archive file
| Installs the specified archive file in place of the version in the autobuild configuration.  This marks the resulting build as 'dirty' but is useful during development. Using this option is equivalent to listing a package name to be installed (so not including the name does not mean that all packages are installed).


|}
|}


[[Category:Autobuild]]
[[Category:Autobuild]]

Latest revision as of 10:45, 29 September 2022

autobuild install
option [value] [option [value]] ...
[package [package ...]]

Installs artifacts of dependency packages for use during the build of the current package.

Argument:

  • package: name of package to consider for installation.

You may specify one or more packages, separated by a space; or none. If no packages are named, autobuild will attempt to install all packages listed in the 'installables' section of the configuration file.

Private Packages:

If a package has been marked as requiring GitHub or GitLab credentials environment variables need to be provided with valid personal access tokens:

  • AUTOBUILD_GITHUB_TOKEN
  • AUTOBUILD_GITLAB_TOKEN

Standard Options

Option Shortcut Value Description
--debug -d None Display debug output
--dry-run -n None Run tool in dry run mode if available
--help -h None Show help message
--quiet -q None Display minimal output
--verbose -v None Display verbose output

Command-Specific Options

Option Shortcut Value Description
--config-file filename N/A File that describes what is installed (defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml"). Use specified configuration file.
--export-manifest N/A None Print the install manifest to stdout and exit.
--installed-manifest filename N/A The file used to record what is installed. Save record of what is installed to the specified file.
--install-dir dir N/A Directory path. Unpack installed files in specified directory
--list N/A None List the archives specified in the package file.
--list-installed N/A None List the installed package names and exit.
--list-licenses N/A None List known licenses and exit.
--platform platform -p platform Platform name Override the automatically determined platform.
--list-install-urls Lists the archive urls for all installed packages


--list-dirty Lists the names of 'dirty' installed packages


--what-installed file-path path to a file installed by some package Lists the archive responsible for installing the specified file; useful when finding conflicts between packages
--versions Prints each package name and its version value
--copyrights Prints each package name and its copyright value
--local archive path to an archive file Installs the specified archive file in place of the version in the autobuild configuration. This marks the resulting build as 'dirty' but is useful during development. Using this option is equivalent to listing a package name to be installed (so not including the name does not mean that all packages are installed).
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Autobuild_install&oldid=1212495"