Skip to content

Commit b889723

Browse files
alexeaglejbedard
alexeagle
authored and
jbedard
committed
chore(docs): add help topics to leftnav (#7292)
--- ### Changes are visible to end-users: no GitOrigin-RevId: 2d61f9d1e0c67bfe977fe561f018fea91c445753
1 parent 4f4cfa8 commit b889723

File tree

2 files changed

+86
-8
lines changed

2 files changed

+86
-8
lines changed

‎cmd/aspect/info/info.go

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,50 @@ In this case only the value(s) for those keys will be printed.
4848
If --show_make_env is specified, the output includes the set of key/value
4949
pairs in the "Make" environment, accessible within BUILD files.
5050
51-
The full list of keys and the meaning of their values is documented in
52-
the bazel User Manual, and can be programmatically obtained with
53-
'aspect help info-keys'.
51+
One or more of the following keys can be supplied as arguments, such as 'info bazel-bin'.
52+
When no arguments are given, most key/values are printed.
5453
55-
See also 'aspect version' for more detailed version information about the tool.`,
54+
| Key | Description |
55+
| ----------------------- | ------------------------------------------------------------------------- |
56+
| bazel-bin | Configuration dependent directory for binaries. |
57+
| bazel-genfiles | Configuration dependent directory for generated files. |
58+
| bazel-testlogs | Configuration dependent directory for logs from a test run. |
59+
| build-language | Print a binary-encoded protocol buffer with the build language structure. |
60+
| character-encoding | Information about the character encoding used by the running JVM. |
61+
| client-env | The specifications to freeze the current client environment. [^1] |
62+
| command_log | Location of the log containing the output from the build commands. |
63+
| committed-heap-size | Amount of memory in bytes that is committed for the JVM to use. |
64+
| default-package-path | The default package path. |
65+
| execution_root | A directory that makes all input and output files visible to the build. |
66+
| gc-count | Number of garbage collection runs. |
67+
| gc-time | The approximate accumulated time spend on garbage collection. |
68+
| install_base | The installation base directory. |
69+
| java-home | Location of the current Java runtime. |
70+
| java-runtime | Name and version of the current Java runtime environment. |
71+
| java-vm | Name and version of the current Java virtual machine. |
72+
| max-heap-size | Maximum amount of memory in bytes that can be used for memory management. |
73+
| output_base | A directory for shared bazel state. [^2] |
74+
| output_path | The output directory. |
75+
| package_path | The search path for resolving package labels. |
76+
| peak-heap-size | The peak amount of used memory in bytes after any call to System.gc(). |
77+
| release | bazel release identifier. |
78+
| repository_cache | The location of the repository download cache used. |
79+
| server_log | The bazel server log path. |
80+
| server_pid | The bazel process id. |
81+
| starlark-semantics | The effective set of Starlark semantics option values. |
82+
| used-heap-size | The amount of used memory in bytes. [^3] |
83+
| used-heap-size-after-gc | The amount of used memory in bytes after a call to System.gc(). |
84+
| workspace | The working directory of the server. |
85+
86+
[^1]:
87+
The output can be added to the project-specific rc file. See
88+
https://bazel.build/designs/2016/06/21/environment.html
89+
90+
[^2]: As well as tool and strategy specific subdirectories.
91+
[^3]:
92+
Note that this is not a good indicator of the actual memory use, as it
93+
includes any remaining inaccessible memory.
94+
`,
5695
GroupID: "built-in",
5796
RunE: interceptors.Run(
5897
[]interceptors.Interceptor{

‎docs/aspect_info.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,50 @@ In this case only the value(s) for those keys will be printed.
2121
If --show_make_env is specified, the output includes the set of key/value
2222
pairs in the "Make" environment, accessible within BUILD files.
2323

24-
The full list of keys and the meaning of their values is documented in
25-
the bazel User Manual, and can be programmatically obtained with
26-
'aspect help info-keys'.
24+
One or more of the following keys can be supplied as arguments, such as 'info bazel-bin'.
25+
When no arguments are given, most key/values are printed.
26+
27+
| Key | Description |
28+
| ----------------------- | ------------------------------------------------------------------------- |
29+
| bazel-bin | Configuration dependent directory for binaries. |
30+
| bazel-genfiles | Configuration dependent directory for generated files. |
31+
| bazel-testlogs | Configuration dependent directory for logs from a test run. |
32+
| build-language | Print a binary-encoded protocol buffer with the build language structure. |
33+
| character-encoding | Information about the character encoding used by the running JVM. |
34+
| client-env | The specifications to freeze the current client environment. [^1] |
35+
| command_log | Location of the log containing the output from the build commands. |
36+
| committed-heap-size | Amount of memory in bytes that is committed for the JVM to use. |
37+
| default-package-path | The default package path. |
38+
| execution_root | A directory that makes all input and output files visible to the build. |
39+
| gc-count | Number of garbage collection runs. |
40+
| gc-time | The approximate accumulated time spend on garbage collection. |
41+
| install_base | The installation base directory. |
42+
| java-home | Location of the current Java runtime. |
43+
| java-runtime | Name and version of the current Java runtime environment. |
44+
| java-vm | Name and version of the current Java virtual machine. |
45+
| max-heap-size | Maximum amount of memory in bytes that can be used for memory management. |
46+
| output_base | A directory for shared bazel state. [^2] |
47+
| output_path | The output directory. |
48+
| package_path | The search path for resolving package labels. |
49+
| peak-heap-size | The peak amount of used memory in bytes after any call to System.gc(). |
50+
| release | bazel release identifier. |
51+
| repository_cache | The location of the repository download cache used. |
52+
| server_log | The bazel server log path. |
53+
| server_pid | The bazel process id. |
54+
| starlark-semantics | The effective set of Starlark semantics option values. |
55+
| used-heap-size | The amount of used memory in bytes. [^3] |
56+
| used-heap-size-after-gc | The amount of used memory in bytes after a call to System.gc(). |
57+
| workspace | The working directory of the server. |
58+
59+
[^1]:
60+
The output can be added to the project-specific rc file. See
61+
https://bazel.build/designs/2016/06/21/environment.html
62+
63+
[^2]: As well as tool and strategy specific subdirectories.
64+
[^3]:
65+
Note that this is not a good indicator of the actual memory use, as it
66+
includes any remaining inaccessible memory.
2767

28-
See also 'aspect version' for more detailed version information about the tool.
2968

3069
```
3170
aspect info [keys] [flags]

0 commit comments

Comments
 (0)