Skip to content

Commit 44bd99e

Browse files
chore: update documentation from upstream Bazel repo [skip ci]
Synchronized pre-converted MDX files from upstream Bazel repository.
1 parent 170ae0f commit 44bd99e

File tree

5 files changed

+10
-19
lines changed

5 files changed

+10
-19
lines changed

about/faq.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,6 @@ Bazel returns a non-zero exit code if the build or test invocation fails, and th
157157

158158
Further details on exit codes are in the [User Manual](/docs/user-manual).
159159

160-
## What future features can we expect in Bazel?
161-
162-
See our [Roadmaps](/about/roadmap).
163-
164160
## Can I use Bazel for my INSERT LANGUAGE HERE project?
165161

166162
Bazel is extensible. Anyone can add support for new languages. Many languages are supported: see the [build encyclopedia](/reference/be/overview) for a list of recommendations and [awesomebazel.com](https://awesomebazel.com/) for a more comprehensive list.

advanced/performance/memory.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ changes to files outside of the working set will be disallowed, until you issue
5959
`bazel clean` or restart the Bazel server.
6060

6161
If you want to specify an exact set of files or directories, use the
62-
`--experimental_active_directories` flag, like so:
62+
`--experimental_working_set` flag, like so:
6363

6464
```sh
6565
bazel build //pkg:target --experimental_enable_skyfocus
66-
--experimental_active_directories=path/to/another/dir,path/to/tests/dir
66+
--experimental_working_set=path/to/another/dir,path/to/tests/dir
6767
```
6868

6969
You can also pass `--experimental_skyfocus_dump_post_gc_stats` to show the
@@ -72,7 +72,7 @@ memory reduction amount:
7272
Putting it altogether, you should see something like this:
7373

7474
```none
75-
$ bazel test //pkg:target //tests/... --experimental_enable_skyfocus --experimental_active_directories=dir1,dir2,dir3/subdir --experimental_skyfocus_dump_post_gc_stats
75+
$ bazel test //pkg:target //tests/... --experimental_enable_skyfocus --experimental_working_set dir1,dir2,dir3/subdir --experimental_skyfocus_dump_post_gc_stats
7676
INFO: --experimental_enable_skyfocus is enabled. Blaze will reclaim memory not needed to build the working set. Run 'blaze dump --skyframe=working_set' to show the working set, after this command.
7777
WARNING: Changes outside of the working set will cause a build error.
7878
INFO: Analyzed 149 targets (4533 packages loaded, 169438 targets configured).

reference/command-line-reference.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1615,8 +1615,8 @@ Miscellaneous options, not otherwise categorized.:
16151615
`--curses=<yes, no or auto>` default: "auto"
16161616
: Use terminal cursor controls to minimize scrolling output.
16171617

1618-
`--[no]disk_cache` default: see description
1619-
: A path to a directory where Bazel can read and write actions and action outputs. If the directory does not exist, it will be created. Use --disk_cache with no value (or --disk_cache=true) to use a default location under the output user root (<outputUserRoot>/cache/disk). Use --nodisk_cache or --disk_cache=false to disable.
1618+
`--disk_cache=<a path>` default: see description
1619+
: A path to a directory where Bazel can read and write actions and action outputs. If the directory does not exist, it will be created.
16201620

16211621
`--[no]enable_platform_specific_config` default: "false"
16221622
: If true, Bazel picks up host-OS-specific config lines from bazelrc files. For example, if the host OS is Linux and you run bazel build, Bazel picks up lines starting with build:linux. Supported OS identifiers are linux, macos, windows, freebsd, and openbsd. Enabling this flag is equivalent to using --config=linux on Linux, --config=windows on Windows, etc.
@@ -3829,7 +3829,7 @@ Options that control build execution:
38293829
[`execution`](#effect_tag_EXECUTION)
38303830

38313831
`--strategy_regexp=<a '<RegexFilter>=value[,value]' assignment>` multiple uses are accumulated
3832-
: Override which spawn strategy should be used to execute spawn actions that have descriptions matching a certain regex_filter. See --per_file_copt for details on regex_filter matching. The last regex_filter that matches the description is used. This option overrides other flags for specifying strategy. Example: --strategy_regexp=//foo.*.cc,-//foo/bar=local means to run actions using local strategy if their descriptions match //foo.*.cc but not //foo/bar. Example: --strategy_regexp='Compiling.\*/bar=local --strategy_regexp=Compiling=sandboxed will run 'Compiling //foo/bar/baz' with the 'local' strategy, but reversing the order would run it with 'sandboxed'.
3832+
: Override which spawn strategy should be used to execute spawn actions that have descriptions matching a certain regex_filter. See --per_file_copt for details onregex_filter matching. The last regex_filter that matches the description is used. This option overrides other flags for specifying strategy. Example: --strategy_regexp=//foo.*.cc,-//foo/bar=local means to run actions using local strategy if their descriptions match //foo.*.cc but not //foo/bar. Example: --strategy_regexp='Compiling.\*/bar=local --strategy_regexp=Compiling=sandboxed will run 'Compiling //foo/bar/baz' with the 'local' strategy, but reversing the order would run it with 'sandboxed'.
38333833

38343834
Tags:
38353835
[`execution`](#effect_tag_EXECUTION)
@@ -4126,7 +4126,7 @@ Options that trigger optimizations of the build time:
41264126
[`host_machine_resource_optimizations`](#effect_tag_HOST_MACHINE_RESOURCE_OPTIMIZATIONS)
41274127

41284128
`--[no]experimental_cpu_load_scheduling` default: "false"
4129-
: Enables the experimental local execution scheduling based on CPU load, not estimation of actions one by one. Experimental scheduling have showed the large benefit on a large local builds on a powerful machines with the large number of cores. Recommended to use with --local_resources=cpu=HOST_CPUS
4129+
: Enables the experimental local execution scheduling based on CPU load, not estimation of actions one by one. Experimental scheduling have showed the large benefit on a large local builds on a powerful machines with the large number of cores. Reccommended to use with --local_resources=cpu=HOST_CPUS
41304130

41314131
Tags:
41324132
[`execution`](#effect_tag_EXECUTION)
@@ -4605,8 +4605,8 @@ Miscellaneous options, not otherwise categorized.:
46054605
`--[no]discard_analysis_cache` default: "false"
46064606
: Discard the analysis cache immediately after the analysis phase completes. Reduces memory usage by ~10%, but makes further incremental builds slower.
46074607

4608-
`--[no]disk_cache` default: see description
4609-
: A path to a directory where Bazel can read and write actions and action outputs. If the directory does not exist, it will be created. Use --disk_cache with no value (or --disk_cache=true) to use a default location under the output user root (<outputUserRoot>/cache/disk). Use --nodisk_cache or --disk_cache=false to disable.
4608+
`--disk_cache=<a path>` default: see description
4609+
: A path to a directory where Bazel can read and write actions and action outputs. If the directory does not exist, it will be created.
46104610

46114611
`--embed_label=<a one-line string>` default: ""
46124612
: Embed source control revision or release label in binary

remote/caching.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -298,11 +298,6 @@ Enable the disk cache as follows:
298298
build --disk_cache=<var>path/to/build/cache</var>
299299
```
300300

301-
You can also run `build --disk_cache` with no value to use a default location
302-
under your [output user root](/reference/user-manual#output-user-root)
303-
(`<outputUserRoot>/cache/disk`), alongside the repository cache. Use
304-
`build --nodisk_cache` to disable the disk cache explicitly.
305-
306301
You can pass a user-specific path to the `--disk_cache` flag using the `~` alias
307302
(Bazel will substitute the current user's home directory). This comes in handy
308303
when enabling the disk cache for all developers of a project via the project's

upstream

Submodule upstream updated 239 files

0 commit comments

Comments
 (0)