From 4cd6799f1aca6f12306cbab2a88dd92d8546d652 Mon Sep 17 00:00:00 2001 From: fwe Date: Mon, 31 Aug 2026 09:04:34 -0700 Subject: [PATCH] Bazel Docs: Move command line reference templates from /site to /docs. The site directory will be deleted soon since DevSite has been deprecated. PiperOrigin-RevId: 973911832 --- docs/BUILD | 9 ++++ docs/BUILD.bazel | 3 ++ docs/command-line-reference-prefix.html | 67 +++++++++++++++++++++++++ docs/command-line-reference-suffix.html | 4 ++ 4 files changed, 83 insertions(+) create mode 100644 docs/BUILD create mode 100644 docs/command-line-reference-prefix.html create mode 100644 docs/command-line-reference-suffix.html diff --git a/docs/BUILD b/docs/BUILD new file mode 100644 index 00000000000000..08fb94ceaab157 --- /dev/null +++ b/docs/BUILD @@ -0,0 +1,9 @@ +# Description: +# Bazel's documentation on bazel.build + +package( + default_applicable_licenses = ["//:license"], + default_visibility = ["//visibility:private"], +) + +licenses(["notice"]) diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel index 86ff5df54bcaad..bb67a905bfd9d5 100644 --- a/docs/BUILD.bazel +++ b/docs/BUILD.bazel @@ -7,10 +7,13 @@ licenses(["notice"]) exports_files( [ + "command-line-reference-prefix.html", + "command-line-reference-suffix.html", "docs/user-manual.md", ], visibility = [ "//scripts/docs:__pkg__", + "//src/main/java/com/google/devtools/build/lib:__pkg__", "//src/test/java/com/google/devtools/build/lib/packages:__pkg__", ], ) diff --git a/docs/command-line-reference-prefix.html b/docs/command-line-reference-prefix.html new file mode 100644 index 00000000000000..05e86aca73b9af --- /dev/null +++ b/docs/command-line-reference-prefix.html @@ -0,0 +1,67 @@ + + + + + + + +

Command-Line Reference

+ +{% dynamic setvar source_file "site/command-line-reference-prefix.html" %} +{% include "_buttons.html" %} + +
+bazel [<startup options>] <command> [<args>]
+
+ +or + +
+bazel [<startup options>] <command> [<args>] -- [<target patterns>]
+
+ +See the User's Guide for the +target patterns syntax. + +

Option Syntax

+ +

+Options can be passed to Bazel 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>
+--<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>
+--<option>=[false|no|0]
+
+

diff --git a/docs/command-line-reference-suffix.html b/docs/command-line-reference-suffix.html new file mode 100644 index 00000000000000..bcbda69a3b1b67 --- /dev/null +++ b/docs/command-line-reference-suffix.html @@ -0,0 +1,4 @@ + +



+ +