From 9e24ebd0a68e5872d6faa32493de78e47007f764 Mon Sep 17 00:00:00 2001 From: Ulf Adams Date: Thu, 23 Jun 2016 09:24:57 +0000 Subject: Generate the command-line reference from bazel help. -- Change-Id: I277f81472520b7f490cb178bb14c9618553cc4b2 Reviewed-on: https://bazel-review.googlesource.com/#/c/3880/ MOS_MIGRATED_REVID=125657323 --- site/command-line-reference-prefix.html | 187 ++++++++++++++++++++++++++++++++ 1 file changed, 187 insertions(+) create mode 100644 site/command-line-reference-prefix.html (limited to 'site/command-line-reference-prefix.html') diff --git a/site/command-line-reference-prefix.html b/site/command-line-reference-prefix.html new file mode 100644 index 0000000000..ff0e03537a --- /dev/null +++ b/site/command-line-reference-prefix.html @@ -0,0 +1,187 @@ +--- +layout: documentation +title: Command-Line Reference +--- + +

Command-Line Reference

+ +
+blaze [<startup options>] <command> [<args>]
+
+ +or + +
+blaze [<startup options>] <command> [<args>] -- [<target patterns>]
+
+ +

Option Syntax

+ +

+Options can be passed to Blaze in different ways. Options that require a value +can be passed with either an equals sign or a space: +

+--<option>=<value>
+--<option> <value>
+
+Some options have a single character short form; in that case, the short form +has to be passed with a single dash and a space. +
+-<short_form> <value>
+
+

+ +

+Boolean options can be enabled as follows: +

+--<option>
+--<option>=[true|yes|1]
+
+ +and disabled as follows: +
+--no<option>
+--no_<option>
+--<option>=[false|no|0]
+
+

+ +

+Tristate options are usually set to automatic by default, and can be +force-enabled as follows: +

+--<option>=[true|yes|1]
+
+or force-disabled as follows: +
+--no<option>
+--no_<option>
+--<option>=[false|no|0]
+
+

+ +

Target Pattern Syntax

+ +

+A target pattern refers to a single or more targets, which are source files, +output files, or rules specified in BUILD files. In addition to plain labels, +Blaze also supports working-directory-relative labels, recursive patterns, and +target subtraction. +

+ +

+All target patterns starting with '//' are resolved relative to the current +workspace. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
//foo/bar:wizJust the single target '//foo/bar:wiz'.
//foo/barEquivalent to '//foo/bar:bar'.
//foo/bar:allAll rules in the package 'foo/bar'.
//foo/...All rules in all packages beneath the directory 'foo'.
//foo/...:allAll rules in all packages beneath the directory 'foo'.
//foo/...:*All targets (rules and files) in all packages beneath the directory 'foo'.
//foo/...:all-targetsAll targets (rules and files) in all packages beneath the directory 'foo'.
+

+ +

+Targets with tags=["manual"] are not included in wildcard +target patterns (..., :*, :all, etc). +Specify such test targets with explicit labels on the command line if +you want Blaze to build/test them. +

+ +

+Target patterns which do not begin with '//' are resolved relative to the +current working directory. These examples assume a working directory of +'foo': + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
:fooEquivalent to '//foo:foo'.
bar:wizEquivalent to '//foo/bar:wiz'.
bar/wizEquivalent to: + '//foo/bar/wiz:wiz' if foo/bar/wiz is a package, + '//foo/bar:wiz' if foo/bar is a package, + '//foo:bar/wiz' otherwise. +
bar:allEquivalent to '//foo/bar:all'.
:allEquivalent to '//foo:all'.
...:allEquivalent to '//foo/...:all'.
...Equivalent to '//foo/...:all'.
bar/...:allEquivalent to '//foo/bar/...:all'.
+

+ +

+By default, directory symlinks are followed for recursive target patterns, +except those that point to under the output base, such as the convenience +symlinks that are created in the root directory of the workspace. +

+ +

+In addition, Blaze does not follow symlinks when evaluating recursive target +patterns in any directory that contains a file named as follows: +

+DONT_FOLLOW_SYMLINKS_WHEN_TRAVERSING_THIS_DIRECTORY_VIA_A_RECURSIVE_TARGET_PATTERN
+
+

+ +

+Target patterns may be preceded by a single dash ('-'), in which +case Blaze subtracts them from the set of targets accumulated by preceding +patterns. Note that this means order matters. In order to pass negative +target patterns, you need to use '--' as an argument to prevent Blaze from +interpreting it as an option, e.g.: +

+blaze build -- foo/... -foo/contrib/...
+
+Note that Blaze may still build targets matched by a negative target pattern due +to dependencies, and may also load the corresponding BUILD files, even if the +targets are never built. +

+ + + -- cgit v1.2.3