Skip to content

Commit e44df3c

Browse files
committed
fix more syntax
1 parent bab7c9c commit e44df3c

File tree

2 files changed

+36
-34
lines changed

2 files changed

+36
-34
lines changed

8.4.2/flags.mdx

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ Specify how an output group's files will be represented in TargetComplete/Aspect
270270

271271
_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_
272272

273-
### standard
273+
### stable
274274

275275
#### --show_make_env
276276
effect: AFFECTS_OUTPUTS,TERMINAL_OUTPUT
@@ -1267,7 +1267,7 @@ If enabled, targets that have unknown attributes set to None fail.
12671267

12681268
_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_
12691269

1270-
### standard
1270+
### stable
12711271

12721272
#### --enable_workspace
12731273
effect: LOADING_AND_ANALYSIS
@@ -1498,7 +1498,7 @@ _May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clea
14981498

14991499
## bazel_client_options
15001500

1501-
### standard
1501+
### stable
15021502

15031503
#### --autodetect_server_javabase
15041504
effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE
@@ -1568,7 +1568,7 @@ effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE
15681568
allowsMultiple: false
15691569
requiresValue: true
15701570
defaultValue:
1571-
If set, specifies the output location to which all build output will be written. Otherwise, the location will be ${OUTPUT_ROOT}/_blaze_${USER}/${MD5_OF_WORKSPACE_ROOT}. Note: If you specify a different option from one to the next Bazel invocation for this value, you'll likely start up a new, additional Bazel server. Bazel starts exactly one server per specified output base. Typically there is one output base per workspace - however, with this option you may have multiple output bases per workspace and thereby run multiple builds for the same client on the same machine concurrently. See 'bazel help shutdown' on how to shutdown a Bazel server.
1571+
If set, specifies the output location to which all build output will be written. Otherwise, the location will be ${OUTPUT_ROOT}/_blaze_${USER}/${MD5_OF_WORKSPACE_ROOT}. Note: If you specify a different option from one to the next Bazel invocation for this value, you'll likely start up a new, additional Bazel server. Bazel starts exactly one server per specified output base. Typically there is one output base per workspace - however, with this option you may have multiple output bases per workspace and thereby run multiple builds for the same client on the same machine concurrently. See 'bazel help shutdown' on how to shutdown a Bazel server.
15721572

15731573
_May apply to commands: startup_
15741574

@@ -1586,7 +1586,7 @@ effect: BAZEL_INTERNAL_CONFIGURATION
15861586
allowsMultiple: false
15871587
requiresValue: false
15881588
defaultValue: false
1589-
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
1589+
If set, downloading using ctx.download{,_and_extract} is not allowed during repository fetching. Note that network access is not completely disabled; ctx.execute could still run an arbitrary executable that accesses the Internet.
15901590

15911591
_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_
15921592

@@ -1715,7 +1715,7 @@ effect: AFFECTS_OUTPUTS,LOSES_INCREMENTAL_STATE
17151715
allowsMultiple: false
17161716
requiresValue: true
17171717
defaultValue:
1718-
If set, specifies a location to write a failure_detail protobuf message if the server experiences a failure and cannot report it via gRPC, as normal. Otherwise, the location will be ${OUTPUT_BASE}/failure_detail.rawproto.
1718+
If set, specifies a location to write a failure_detail protobuf message if the server experiences a failure and cannot report it via gRPC, as normal. Otherwise, the location will be ${OUTPUT_BASE}/failure_detail.rawproto.
17191719

17201720
_May apply to commands: startup_
17211721

@@ -1930,7 +1930,7 @@ _May apply to commands: startup, analyze-profile, aquery, build, canonicalize-fl
19301930

19311931
## output_parameters
19321932

1933-
### standard
1933+
### stable
19341934

19351935
#### --host_conlyopt
19361936
effect: ACTION_COMMAND_LINES,AFFECTS_OUTPUTS
@@ -2439,7 +2439,7 @@ effect: AFFECTS_OUTPUTS
24392439
allowsMultiple: false
24402440
requiresValue: true
24412441
defaultValue:
2442-
Instead of downloading remote build outputs to the local machine, create symbolic links. The target of the symbolic links can be specified in the form of a template string. This template string may contain {hash} and {size_bytes} that expand to the hash of the object and the size in bytes, respectively. These symbolic links may, for example, point to a FUSE file system that loads objects from the CAS on demand.
2442+
Instead of downloading remote build outputs to the local machine, create symbolic links. The target of the symbolic links can be specified in the form of a template string. This template string may contain {hash} and {size_bytes} that expand to the hash of the object and the size in bytes, respectively. These symbolic links may, for example, point to a FUSE file system that loads objects from the CAS on demand.
24432443

24442444
_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_
24452445

@@ -2522,7 +2522,7 @@ effect: AFFECTS_OUTPUTS,EXECUTION
25222522
allowsMultiple: false
25232523
requiresValue: true
25242524
defaultValue:
2525-
If set, write a shell script to the given file which invokes the target. If this option is set, the target is not run from Bazel. Use '%{product} run --script_path=foo //foo && ./foo' to invoke target '//foo' This differs from '%{product} run //foo' in that the %{product} lock is released and the executable is connected to the terminal's stdin.
2525+
If set, write a shell script to the given file which invokes the target. If this option is set, the target is not run from Bazel. Use '%{product} run --script_path=foo //foo && ./foo' to invoke target '//foo' This differs from '%{product} run //foo' in that the %{product} lock is released and the executable is connected to the terminal's stdin.
25262526

25272527
_May apply to commands: run_
25282528

@@ -2930,7 +2930,7 @@ _May apply to commands: aquery, build, canonicalize-flags, clean, config, covera
29302930

29312931
## remote
29322932

2933-
### standard
2933+
### stable
29342934

29352935
#### --remote_build_event_upload
29362936
enum values: ALL,MINIMAL
@@ -3096,7 +3096,7 @@ effect: UNKNOWN
30963096
allowsMultiple: false
30973097
requiresValue: true
30983098
defaultValue:
3099-
The hostname and instance name to be used in bytestream:// URIs that are written into build event streams. This option can be set when builds are performed using a proxy, which causes the values of --remote_executor and --remote_instance_name to no longer correspond to the canonical name of the remote execution service. When not set, it will default to "${hostname}/${instance_name}".
3099+
The hostname and instance name to be used in bytestream:// URIs that are written into build event streams. This option can be set when builds are performed using a proxy, which causes the values of --remote_executor and --remote_instance_name to no longer correspond to the canonical name of the remote execution service. When not set, it will default to "${hostname}/${instance_name}".
31003100

31013101
_May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clean, config, coverage, cquery, dump, fetch, help, info, license, mobile-install, mod, print_action, query, run, shutdown, sync, test, vendor, version_
31023102

@@ -3414,7 +3414,7 @@ _May apply to commands: aquery, build, canonicalize-flags, clean, config, covera
34143414

34153415
## signing
34163416

3417-
### standard
3417+
### stable
34183418

34193419
#### --device_debug_entitlements
34203420
effect: CHANGES_INPUTS
@@ -3446,15 +3446,15 @@ _May apply to commands: aquery, build, canonicalize-flags, clean, config, covera
34463446

34473447
## query
34483448

3449-
### standard
3449+
### stable
34503450

34513451
#### --aspect_deps
34523452
enum values: OFF,CONSERVATIVE,PRECISE
34533453
effect: BUILD_FILE_SEMANTICS
34543454
allowsMultiple: false
34553455
requiresValue: true
34563456
defaultValue: conservative
3457-
How to resolve aspect dependencies when the output format is one of {xml,proto,record}. 'off' means no aspect dependencies are resolved, 'conservative' (the default) means all declared aspect dependencies are added regardless of whether they are given the rule class of direct dependencies, 'precise' means that only those aspects are added that are possibly active given the rule class of the direct dependencies. Note that precise mode requires loading other packages to evaluate a single target thus making it slower than the other modes. Also note that even precise mode is not completely precise: the decision whether to compute an aspect is decided in the analysis phase, which is not run during 'bazel query'.
3457+
How to resolve aspect dependencies when the output format is one of {xml,proto,record}. 'off' means no aspect dependencies are resolved, 'conservative' (the default) means all declared aspect dependencies are added regardless of whether they are given the rule class of direct dependencies, 'precise' means that only those aspects are added that are possibly active given the rule class of the direct dependencies. Note that precise mode requires loading other packages to evaluate a single target thus making it slower than the other modes. Also note that even precise mode is not completely precise: the decision whether to compute an aspect is decided in the analysis phase, which is not run during 'bazel query'.
34583458

34593459
_May apply to commands: aquery, cquery, query_
34603460

@@ -4206,7 +4206,7 @@ If set to true, additionally use semaphore to limit number of concurrent jobs.
42064206

42074207
_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_
42084208

4209-
### standard
4209+
### stable
42104210

42114211
#### --worker_multiplex
42124212
effect: EXECUTION,HOST_MACHINE_RESOURCE_OPTIMIZATIONS
@@ -4577,13 +4577,13 @@ _May apply to commands: mobile-install_
45774577

45784578
## mod_command
45794579

4580-
### standard
4580+
### stable
45814581

45824582
#### --base_module
45834583
effect: TERMINAL_OUTPUT
45844584
allowsMultiple: false
45854585
requiresValue: true
4586-
defaultValue: <root>
4586+
defaultValue: &lt;root&gt;
45874587
Specify a module relative to which the specified target repos will be interpreted.
45884588

45894589
_May apply to commands: mod_
@@ -4677,15 +4677,15 @@ _May apply to commands: mod_
46774677
effect: TERMINAL_OUTPUT
46784678
allowsMultiple: false
46794679
requiresValue: true
4680-
defaultValue: <root>
4680+
defaultValue: &lt;root&gt;
46814681
The module(s) starting from which the dependency graph query will be displayed. Check each query’s description for the exact semantics. Defaults to &lt;root&gt;.
46824682

46834683

46844684
_May apply to commands: mod_
46854685

46864686
## output_selection
46874687

4688-
### standard
4688+
### stable
46894689

46904690
#### --packages
46914691
effect: BAZEL_MONITORING
@@ -4810,7 +4810,7 @@ effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS
48104810
allowsMultiple: false
48114811
requiresValue: false
48124812
defaultValue: false
4813-
If true, clean removes the entire working tree for this Bazel instance, which includes all %{product}-created temporary and build output files, and stops the %{product} server if it is running.
4813+
If true, clean removes the entire working tree for this Bazel instance, which includes all %&lbrace;product&rbrace;-created temporary and build output files, and stops the %&lbrace;product&rbrace; server if it is running.
48144814

48154815
_May apply to commands: clean_
48164816

@@ -4820,7 +4820,7 @@ effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS
48204820
allowsMultiple: false
48214821
requiresValue: false
48224822
defaultValue:
4823-
If specified, clean asynchronously removes the entire working tree for this Bazel instance, which includes all %{product}-created temporary and build output files, and stops the %{product} server if it is running. When this command completes, it will be safe to execute new commands in the same client, even though the deletion may continue in the background.
4823+
If specified, clean asynchronously removes the entire working tree for this Bazel instance, which includes all %&lbrace;product&rbrace;-created temporary and build output files, and stops the %&lbrace;product&rbrace; server if it is running. When this command completes, it will be safe to execute new commands in the same client, even though the deletion may continue in the background.
48244824

48254825
_May apply to commands: clean_
48264826

@@ -4937,7 +4937,7 @@ effect: LOADING_AND_ANALYSIS,ACTION_COMMAND_LINES,AFFECTS_OUTPUTS
49374937
allowsMultiple: false
49384938
requiresValue: true
49394939
defaultValue: no
4940-
Specifies which compilation modes use fission for C++ compilations and links. May be any combination of {'fastbuild', 'dbg', 'opt'} or the special values 'yes' to enable all modes and 'no' to disable all modes.
4940+
Specifies which compilation modes use fission for C++ compilations and links. May be any combination of &lbrace;'fastbuild', 'dbg', 'opt'&rbrace; or the special values 'yes' to enable all modes and 'no' to disable all modes.
49414941

49424942
_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_
49434943

@@ -5019,7 +5019,7 @@ _May apply to commands: canonicalize-flags_
50195019

50205020
## bzlmod
50215021

5022-
### standard
5022+
### stable
50235023

50245024
#### --lockfile_mode
50255025
enum values: OFF,UPDATE,REFRESH,ERROR
@@ -5064,7 +5064,7 @@ effect: CHANGES_INPUTS
50645064
allowsMultiple: true
50655065
requiresValue: true
50665066
defaultValue:
5067-
Only fetches the specified repository, which can be either {@apparent_repo_name} or {@@canonical_repo_name}. Only works when --enable_bzlmod is on.
5067+
Only fetches the specified repository, which can be either &lbrace;@apparent_repo_name&rbrace; or &lbrace;@@canonical_repo_name&rbrace;. Only works when --enable_bzlmod is on.
50685068

50695069
_May apply to commands: fetch, vendor_
50705070

@@ -5139,7 +5139,7 @@ _May apply to commands: fetch_
51395139

51405140
## uncategorized
51415141

5142-
### standard
5142+
### stable
51435143

51445144
#### --show_timestamps
51455145
effect: UNKNOWN
@@ -6184,7 +6184,7 @@ _May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clea
61846184

61856185
## build_time_optimization
61866186

6187-
### standard
6187+
### stable
61886188

61896189
#### --gc_thrashing_limits
61906190
effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS
@@ -6282,7 +6282,7 @@ effect: HOST_MACHINE_RESOURCE_OPTIMIZATIONS
62826282
allowsMultiple: true
62836283
requiresValue: true
62846284
defaultValue:
6285-
Set the number of resources available to Bazel. Takes in an assignment to a float or HOST_RAM/HOST_CPUS, optionally followed by [-|*]&lt;float&gt; (eg. memory=HOST_RAM*.5 to use half the available RAM). Can be used multiple times to specify multiple types of resources. Bazel will limit concurrently running actions based on the available resources and the resources required. Tests can declare the amount of resources they need by using a tag of the "resources:&lt;resource name&gt;:&lt;amount&gt;" format. Overrides resources specified by --local_{cpu|ram|extra}_resources.
6285+
Set the number of resources available to Bazel. Takes in an assignment to a float or HOST_RAM/HOST_CPUS, optionally followed by [-|*]&lt;float&gt; (eg. memory=HOST_RAM*.5 to use half the available RAM). Can be used multiple times to specify multiple types of resources. Bazel will limit concurrently running actions based on the available resources and the resources required. Tests can declare the amount of resources they need by using a tag of the "resources:&lt;resource name&gt;:&lt;amount&gt;" format. Overrides resources specified by --local_&lbrace;cpu|ram|extra&rbrace;_resources.
62866286

62876287
_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_
62886288

@@ -6438,7 +6438,7 @@ _May apply to commands: analyze-profile, aquery, build, canonicalize-flags, clea
64386438

64396439
## testing
64406440

6441-
### standard
6441+
### stable
64426442

64436443
#### --test_env
64446444
effect: TEST_RUNNER
@@ -6701,7 +6701,7 @@ If enabled, check testonly for prerequisite targets that are output files by loo
67016701

67026702
_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, mod, print_action, query, run, sync, test, vendor_
67036703

6704-
### standard
6704+
### stable
67056705

67066706
#### --check_bzl_visibility
67076707
effect: BUILD_FILE_SEMANTICS
@@ -6925,7 +6925,7 @@ _May apply to commands: aquery, build, canonicalize-flags, clean, config, covera
69256925

69266926
## toolchain
69276927

6928-
### standard
6928+
### stable
69296929

69306930
#### --android_manifest_merger
69316931
enum values: LEGACY,ANDROID,FORCE_ANDROID
@@ -7279,7 +7279,7 @@ effect: LOSES_INCREMENTAL_STATE,LOADING_AND_ANALYSIS,EXECUTION
72797279
allowsMultiple: false
72807280
requiresValue: false
72817281
defaultValue: false
7282-
If set, add a "requires-xcode:{version}" execution requirement to every Xcode action. If the Xcode version has a hyphenated label, also add a "requires-xcode-label:{version_label}" execution requirement.
7282+
If set, add a "requires-xcode:&lbrace;version&rbrace;" execution requirement to every Xcode action. If the Xcode version has a hyphenated label, also add a "requires-xcode-label:&lbrace;version_label&rbrace;" execution requirement.
72837283

72847284
_May apply to commands: aquery, build, canonicalize-flags, clean, config, coverage, cquery, fetch, info, mobile-install, print_action, run, test, vendor_
72857285

@@ -7305,7 +7305,7 @@ _May apply to commands: aquery, build, canonicalize-flags, clean, config, covera
73057305

73067306
## generic_inputs
73077307

7308-
### standard
7308+
### stable
73097309

73107310
#### --flag_alias
73117311
effect: CHANGES_INPUTS

flags_to_markdown_converter/convert.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ function escapeHtml(str) {
66
return str
77
.replace(/&/g, "&amp;")
88
.replace(/</g, "&lt;")
9-
.replace(/>/g, "&gt;");
9+
.replace(/>/g, "&gt;")
10+
.replace(/{/g, "&lbrace;")
11+
.replace(/}/g, "&rbrace;");
1012
}
1113

1214
// Read stdin as a stream
@@ -72,7 +74,7 @@ for (const category of flagsByCategory.keys()) {
7274
writeLine('effect: ' + flag.effectTags)
7375
writeLine('allowsMultiple: ' + flag.allowsMultiple)
7476
writeLine('requiresValue: ' + flag.requiresValue)
75-
writeLine('defaultValue: ' + flag.defaultValue)
77+
writeLine(`defaultValue: ${escapeHtml(flag.defaultValue)}`);
7678

7779
// TODO: add history - what version of Bazel introduced this flag?
7880
// TODO: link to GitHub issue where the flag is being managed (i.e. graduate from experimental)

0 commit comments

Comments
 (0)