aboutsummaryrefslogtreecommitdiffhomepage
path: root/site
diff options
context:
space:
mode:
authorGravatar twerth <twerth@google.com>2018-08-09 08:03:41 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-08-09 08:05:04 -0700
commite7fcab3fbca88fb8637881f3b2cf0ea8a1e9c8bf (patch)
treef569d846e78443e28cd54adf68f66ae6656cd4a2 /site
parentc0dfe1d274f4f01f3bf422f9a98738b3f328f359 (diff)
Add minimal documentation for the new aquery command.
RELNOTES: None PiperOrigin-RevId: 208049281
Diffstat (limited to 'site')
-rw-r--r--site/docs/user-manual.html25
1 files changed, 25 insertions, 0 deletions
diff --git a/site/docs/user-manual.html b/site/docs/user-manual.html
index c4c947bb70..c2d54f2662 100644
--- a/site/docs/user-manual.html
+++ b/site/docs/user-manual.html
@@ -20,6 +20,7 @@ title: User Manual
Available commands:
<a href='#analyze-profile'>analyze-profile</a> Analyzes build profile data.
+ <a href='#aquery'>aquery</a> Executes a query on the <a href='#analysis-phase'>post-analysis</a> action graph.
<a href='#build'>build</a> Builds the specified targets.
<a href='#canonicalize'>canonicalize-flags</a> Canonicalize Bazel flags.
@@ -3064,6 +3065,30 @@ Examples:
bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'
</pre>
+<h2 id='aquery'>Querying the action graph with Bazel</h2>
+
+<b>Caution</b>: The aquery command is still experimental and its API will change.
+
+<p>
+ The <code>aquery</code> command allows you to query for actions in your build graph.
+ It operates on the post-analysis configured target graph and exposes
+ information about actions, artifacts and their relationships.
+</p>
+
+<p>
+ The tool accepts several command-line options.
+ <code class='flag'>--output</code> selects the output format
+ (<code>proto</code> is the default, use <code>text</code> for human readable
+ output).
+ Notably, the aquery command runs on top of a regular Bazel build and inherits
+ the set of options available during a build.
+</p>
+
+<p>
+ It supports the same set of functions that is also available to traditional
+ <code>query</code> but <code>siblings</code>, <code>buildfiles</code> and
+ <code>tests</code>.
+</p>
<h2 id='misc'>Miscellaneous Bazel commands and options</h2>