Difference between revisions of "Autobuild edit"

Latest revision as of 10:30, 19 March 2015

Autobuild command

autobuild edit subcommand 
    option [value] [option [value] ...] 
    [argument [argument ...]] 

Edits the definition of the current package. The subcommand specifies what to edit, and is one of:

build: Configures autobuild build.
configure: Configures autobuild configure.
package: Configures information about the package.
platform: Configures platform-specific configuration.

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
--delete	N/A	?
--config-file config_file	N/A	Configuration file	Use specified configuration file

Arguments for build subcommand

name - Name of config
platform - Platform of config
command - Command to execute
options - Options for command
arguments - Arguments for command

Arguments for package subcommand

name - Name of package
description - Package description
copyright - Copyright string (as appropriate for your package)
license - Type of license (as appropriate for your package)
license_file - Path to license file relative to package root, if known
version_file - Path to a file containing the package version number after the build

Arguments for platform subcommand

name - Name of platform
build_directory - Build directory

@@ 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 edit ''subcommand'' <br>    ''option'' [''value''] [''option'' [''value''] ...] <br>    [argument [argument ...]]
+|comments=
+Edits the definition of the current package.
+The ''subcommand'' specifies what to edit, and is one of:
+* build: Configures <code>autobuild build</code>.
+* configure: Configures <code>autobuild configure</code>.
+* package: Configures information about the package.
+* platform: Configures platform-specific configuration.
+}}
-Rather than changing this page directly, or at least after having done so,
+'''Command-Specific Options'''
-consider making the change to the command help itself (or suggest doing so
+{| class=lltable border=1
-to the author).
+|--
-======================================================================== -->
+!Option
-Usage:
+!Shortcut
-       <nowiki>autobuild build [-h] [--no-configure] [--config-file CONFIG_FILE] [-a]</nowiki>
+!Value
-                       <nowiki>[-c CONFIGURATION] [--dry-run] -- [OPT [OPT ...]]</nowiki>
+!Description
+|-
+| --delete
+| N/A
+| ?
-Arguments:
+|-
+| --config-file ''config_file''
+| N/A
+| Configuration file
+| Use specified configuration file
-:;<nowiki>OPT</nowiki>
+|}
-::<nowiki>an option to pass to the build command </nowiki>
-Options:
-:{|border="0" cellpadding="5" style="border-collapse: collapse; border-style: none;"
-|- style="vertical-align: top;"
-|<nowiki>-h, --help</nowiki>
-|<nowiki>show this help message and exit</nowiki>
-|- style="vertical-align: top;"
-|<nowiki>--config-file&nbsp;CONFIG_FILE</nowiki>
-| <nowiki>(defaults to $AUTOBUILD_CONFIG_FILE or "autobuild.xml")</nowiki>
-|- style="vertical-align: top;"
-|<nowiki>--no-configure</nowiki>
-|<nowiki>do not configure before building</nowiki>
-|- style="vertical-align: top;"
+'''Arguments for build subcommand'''
-|<nowiki>--all, -a</nowiki>
-|<nowiki>build all configurations</nowiki>
-|- style="vertical-align: top;"
+* name - Name of config
-|<nowiki>--configuration&nbsp;[CONFIGURATION], -c&nbsp;[CONFIGURATION]</nowiki>
+*platform - Platform of config
-| <nowiki>build a specific build configuration (may be specified as comma separated values in $AUTOBUILD_CONFIGURATION)</nowiki>
+*command - Command to execute
+*options - Options for command
+*arguments - Arguments for command
-|- style="vertical-align: top;"
-|<nowiki>--use-cwd</nowiki>
-|<nowiki>build in current working directory</nowiki>
-|- style="vertical-align: top;"
+'''Arguments for package subcommand'''
-|<nowiki>-n, --dry-run</nowiki>
-|<nowiki>run tool in dry run mode if available</nowiki>
-|- style="vertical-align: top;"
+*name - Name of package
-|<nowiki>-q, --quiet</nowiki>
+*description - Package description
-|<nowiki>minimal output</nowiki>
+*copyright - Copyright string (as appropriate for your package)
+*license - Type of license (as appropriate for your package)
+*license_file - Path to license file relative to package root, if known
+*version_file - Path to a file containing the package version number after the build
-|- style="vertical-align: top;"
+'''Arguments for platform subcommand'''
-|<nowiki>-v, --verbose</nowiki>
-|<nowiki>verbose output</nowiki>
-|- style="vertical-align: top;"
+*name - Name of platform
-|<nowiki>-d, --debug</nowiki>
+*build_directory - Build directory
-|}
 [[Category:Autobuild]]

Difference between revisions of "Autobuild edit"

Latest revision as of 10:30, 19 March 2015

Navigation menu

Search