Skip to content

docs preview: bazelbuild/bazel#29932 #522

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
bazel-docs-pull-requestor wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs preview: bazelbuild/bazel#29932 #522

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
8 changes: 5 additions & 3 deletions reference/be/protocol-buffer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: 'Protocol Buffer Rules'

## cc_proto_library

[View rule sourceopen_in_new](https://github.com/protocolbuffers/protobuf/tree/v29.0-rc2/bazel/private/oss/cc_proto_library.bzl)
[View rule sourceopen_in_new](https://github.com/protocolbuffers/protobuf/tree/v29.0-rc2/bazel/private/bazel_cc_proto_library.bzl)

```
cc_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
Expand Down Expand Up @@ -88,7 +88,7 @@ proto_library(

## java_proto_library

[View rule sourceopen_in_new](https://github.com/protocolbuffers/protobuf/tree/v29.0-rc2/bazel/private/java_proto_library.bzl)
[View rule sourceopen_in_new](https://github.com/protocolbuffers/protobuf/tree/v29.0-rc2/bazel/private/bazel_java_proto_library_rule.bzl)

```
java_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, licenses, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
Expand Down Expand Up @@ -171,7 +171,7 @@ Recommended code organization:

## py_proto_library

[View rule sourceopen_in_new](https://github.com/protocolbuffers/protobuf/tree/v29.0-rc2/bazel/private/oss/py_proto_library.bzl)
[View rule sourceopen_in_new](https://github.com/protocolbuffers/protobuf/tree/v29.0-rc2/bazel/py_proto_library.bzl)

```
py_proto_library(name, deps, aspect_hints, compatible_with, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, package_metadata, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
Expand Down Expand Up @@ -212,6 +212,8 @@ srcs = ["foo.proto"],
proto_lang_toolchain(name, allowlist_different_package, aspect_hints, blacklisted_protos, command_line, compatible_with, denylisted_protos, deprecation, exec_compatible_with, exec_group_compatible_with, exec_properties, features, mnemonic, output_files, package_metadata, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)
```

If using Bazel, please load the rule from https://github.com/bazelbuild/rules_proto.

Specifies how a LANG_proto_library rule (e.g., `java_proto_library`) should invoke the
proto-compiler.
Some LANG_proto_library rules allow specifying which toolchain to use using command-line flags;
Expand Down
58 changes: 44 additions & 14 deletions reference/command-line-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,6 @@ Options that appear before the command and are parsed by the client:
Tags:
[`bazel_monitoring`](#effect_tag_BAZEL_MONITORING), [`execution`](#effect_tag_EXECUTION)

`--[no]experimental_use_compact_object_headers` default: "true"
: Use compact object headers in the JVM. Enabled by default for Bazel when using the embedded JDK. This can reduce memory usage by 5-7%.

Tags:
[`bazel_internal_configuration`](#effect_tag_BAZEL_INTERNAL_CONFIGURATION), [`host_machine_resource_optimizations`](#effect_tag_HOST_MACHINE_RESOURCE_OPTIMIZATIONS)

`--extra_classpath=<a string>` default: ""
: A colon-separated list of classpath entries to be added to the classpath of the Bazel server.

Expand Down Expand Up @@ -541,17 +535,17 @@ This option affects semantics of the Starlark language or the build API accessib
Tags:
[`build_file_semantics`](#effect_tag_BUILD_FILE_SEMANTICS), [`loading_and_analysis`](#effect_tag_LOADING_AND_ANALYSIS), [`experimental`](#metadata_tag_EXPERIMENTAL)

`--[no]experimental_dormant_deps` default: "false"
: If set to true, attr.label(materializer=), attr(for_dependency_resolution=), attr.dormant_label(), attr.dormant_label_list() and rule(for_dependency_resolution=) are allowed.
`--[no]experimental_disable_external_package` default: "false"
: If set to true, the auto-generated //external package will not be available anymore. Bazel will still be unable to parse the file 'external/BUILD', but globs reaching into external/ from the unnamed package will work.

Tags:
[`build_file_semantics`](#effect_tag_BUILD_FILE_SEMANTICS), [`experimental`](#metadata_tag_EXPERIMENTAL)
[`loading_and_analysis`](#effect_tag_LOADING_AND_ANALYSIS), [`loses_incremental_state`](#effect_tag_LOSES_INCREMENTAL_STATE), [`experimental`](#metadata_tag_EXPERIMENTAL)

`--[no]experimental_enable_android_migration_apis` default: "false"
: If set to true, enables the APIs required to support the Android Starlark migration.
`--[no]experimental_dormant_deps` default: "false"
: If set to true, attr.label(materializer=), attr(for_dependency_resolution=), attr.dormant_label(), attr.dormant_label_list() and rule(for_dependency_resolution=) are allowed.

Tags:
[`build_file_semantics`](#effect_tag_BUILD_FILE_SEMANTICS)
[`build_file_semantics`](#effect_tag_BUILD_FILE_SEMANTICS), [`experimental`](#metadata_tag_EXPERIMENTAL)

`--[no]experimental_enable_first_class_macros` default: "true"
: If set to true, enables the `macro()` construct for defining symbolic macros.
Expand Down Expand Up @@ -3500,6 +3494,12 @@ Miscellaneous options, not otherwise categorized.:
`--test_filter=<a string>` default: see description
: Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.

`--test_result_expiration=<an integer>` default: "-1"
: This option is deprecated and has no effect.

Tags:
[`deprecated`](#metadata_tag_DEPRECATED)

`--[no]test_runner_fail_fast` default: "false"
: Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.

Expand Down Expand Up @@ -3646,7 +3646,7 @@ Options that control build execution:
[`execution`](#effect_tag_EXECUTION)

`--experimental_sandbox_limits=<a named double, 'name=value', where value is an integer, or a keyword ("HOST_CPUS", "HOST_RAM"), optionally followed by an operation ([-|*]<float>) eg. "HOST_CPUS", "HOST_CPUS*.5">` multiple uses are accumulated
: If &gt; 0, each Linux sandbox will be limited to the given amount for the specified resource. This overrides --experimental_sandbox_memory_limit_mb. Requires cgroups v1 or v2 and permissions for the users to the cgroups dir.
: If &gt; 0, each Linux sandbox will be limited to the given amount for the specified resource. Requires --incompatible_use_new_cgroup_implementation and overrides --experimental_sandbox_memory_limit_mb. Requires cgroups v1 or v2 and permissions for the users to the cgroups dir.

Tags:
[`execution`](#effect_tag_EXECUTION)
Expand Down Expand Up @@ -3741,6 +3741,12 @@ Options that control build execution:
Tags:
[`execution`](#effect_tag_EXECUTION)

`--[no]incompatible_use_new_cgroup_implementation` default: "true"
: If true, use the new implementation for cgroups. The old implementation only supports the memory controller and ignores the value of --experimental_sandbox_limits.

Tags:
[`execution`](#effect_tag_EXECUTION)

`--[no]internal_spawn_scheduler` default: "true"
: Placeholder option so that we can tell in Blaze whether the spawn scheduler was enabled.

Expand Down Expand Up @@ -6124,6 +6130,12 @@ Miscellaneous options, not otherwise categorized.:
`--test_filter=<a string>` default: see description
: Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.

`--test_result_expiration=<an integer>` default: "-1"
: This option is deprecated and has no effect.

Tags:
[`deprecated`](#metadata_tag_DEPRECATED)

`--[no]test_runner_fail_fast` default: "false"
: Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.

Expand Down Expand Up @@ -7893,6 +7905,12 @@ Miscellaneous options, not otherwise categorized.:
`--test_filter=<a string>` default: see description
: Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.

`--test_result_expiration=<an integer>` default: "-1"
: This option is deprecated and has no effect.

Tags:
[`deprecated`](#metadata_tag_DEPRECATED)

`--[no]test_runner_fail_fast` default: "false"
: Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.

Expand Down Expand Up @@ -7967,7 +7985,7 @@ Options that control the output of the command:
[`bazel_monitoring`](#effect_tag_BAZEL_MONITORING)

`--skykey_filter=<a comma-separated list of regex expressions with prefix '-' specifying excluded paths>` default: ".\*"
: Regex filter of SkyKey names to output. Only used with --skyframe=value, deps, rdeps, function_graph.
: Regex filter of SkyKey names to output. Only used with --skyframe=deps, rdeps, function_graph.

Tags:
[`bazel_monitoring`](#effect_tag_BAZEL_MONITORING)
Expand Down Expand Up @@ -9495,6 +9513,12 @@ Miscellaneous options, not otherwise categorized.:
`--test_filter=<a string>` default: see description
: Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.

`--test_result_expiration=<an integer>` default: "-1"
: This option is deprecated and has no effect.

Tags:
[`deprecated`](#metadata_tag_DEPRECATED)

`--[no]test_runner_fail_fast` default: "false"
: Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.

Expand Down Expand Up @@ -12443,6 +12467,12 @@ Miscellaneous options, not otherwise categorized.:
`--test_filter=<a string>` default: see description
: Specifies a filter to forward to the test framework. Used to limit the tests run. Note that this does not affect which targets are built.

`--test_result_expiration=<an integer>` default: "-1"
: This option is deprecated and has no effect.

Tags:
[`deprecated`](#metadata_tag_DEPRECATED)

`--[no]test_runner_fail_fast` default: "false"
: Forwards fail fast option to the test runner. The test runner should stop execution upon first failure.

Expand Down
2 changes: 1 addition & 1 deletion reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion upstream
Open in desktop
Submodule upstream updated 211 files
2 changes: 1 addition & 1 deletion versions/7.6.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd">
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd">
JUnit test result schema
</a>
</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/7.7.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ The initial environment block shall be composed as follows:
</tr>
<tr>
<td><code>XML_OUTPUT_FILE</code></td>
<td>Location to which test actions should write a test result XML output file. Otherwise, Bazel generates a default XML output file wrapping the test log as part of the test action. The XML schema is based on the <a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd" class="external">JUnit test result schema</a>.</td>
<td>Location to which test actions should write a test result XML output file. Otherwise, Bazel generates a default XML output file wrapping the test log as part of the test action. The XML schema is based on the <a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd" class="external">JUnit test result schema</a>.</td>
<td>optional</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.0.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.1.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.2.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.3.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd" class="external">JUnit test result schema</a>.
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd" class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.4.2/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.5.1/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.6.0/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/8.7.0/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/9.0.0/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ The initial environment block shall be composed as follows:
Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.
</td>
<td>optional</td>
Expand Down
2 changes: 1 addition & 1 deletion versions/9.1.0/reference/test-encyclopedia.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ The initial environment block shall be composed as follows:
<td>Location to which test actions should write a test result XML output file.
Otherwise, Bazel generates a default XML output file wrapping the test log
as part of the test action. The XML schema is based on the
<a href="https://github.com/windyroad/JUnit-Schema/blob/1.0.0/JUnit.xsd"
<a href="https://windyroad.com.au/dl/Open%20Source/JUnit.xsd"
class="external">JUnit test result schema</a>.</td>
<td>optional</td>
</tr>
Expand Down