Skip to content

[Docs Preview] Bazel Docs: Move command line reference templates from /site to /docs. #30934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
copybara-service wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[Docs Preview] Bazel Docs: Move command line reference templates from /site to /docs. #30934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Description:
# Bazel's documentation on bazel.build

package(
default_applicable_licenses = ["//:license"],
default_visibility = ["//visibility:private"],
)

licenses(["notice"])
3 changes: 3 additions & 0 deletions docs/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__",
],
)
Expand Down
67 changes: 67 additions & 0 deletions docs/command-line-reference-prefix.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<html devsite>
<head>
<meta name="project_path" value="/_project.yaml">
<meta name="book_path" value="/_book.yaml">
</head>
<body>

<h1 class="page-title">Command-Line Reference</h1>

{% dynamic setvar source_file "site/command-line-reference-prefix.html" %}
{% include "_buttons.html" %}

<pre>
bazel [&lt;startup options&gt;] &lt;command&gt; [&lt;args&gt;]
</pre>

or

<pre>
bazel [&lt;startup options&gt;] &lt;command&gt; [&lt;args&gt;] -- [&lt;target patterns&gt;]
</pre>

See the <a href="/docs/build#specifying-build-targets">User's Guide</a> for the
target patterns syntax.

<h2>Option Syntax</h2>

<p>
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:
<pre>
--&lt;option&gt;=&lt;value&gt;
--&lt;option&gt; &lt;value&gt;
</pre>
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.
<pre>
-&lt;short_form&gt; &lt;value&gt;
</pre>
</p>

<p>
Boolean options can be enabled as follows:
<pre>
--&lt;option&gt;
--&lt;option&gt;=[true|yes|1]
</pre>

and disabled as follows:
<pre>
--no&lt;option&gt;
--&lt;option&gt;=[false|no|0]
</pre>
</p>

<p>
Tristate options are usually set to automatic by default, and can be
force-enabled as follows:
<pre>
--&lt;option&gt;=[true|yes|1]
</pre>
or force-disabled as follows:
<pre>
--no&lt;option&gt;
--&lt;option&gt;=[false|no|0]
</pre>
</p>
4 changes: 4 additions & 0 deletions docs/command-line-reference-suffix.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

<br/><br/><br/><br/>
</body>
</html>