Clarify whether env vars will be expanded

anupli · Nov 20, 2023 · 6d76db7 · 6d76db7
1 parent fdbd1ac
commit 6d76db7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/docs/src/references/modifier.md b/docs/src/references/modifier.md
@@ -5,6 +5,7 @@
 `var`: name of the variable.
 
 `val`: value of the variable.
+Environment variables will be expanded.
 
 ### Description
 Set an environment variable. Might override an environment variable inherited from the parent process.
@@ -14,6 +15,7 @@ Set an environment variable. Might override an environment variable inherited fr
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple arguments are space separated.
+Environment variables will be expanded.
 
 ### Description
 Specify arguments to a JVM, as opposed to the program.
@@ -23,6 +25,7 @@ Specify arguments to a JVM, as opposed to the program.
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple arguments are space separated.
+Environment variables will be expanded.
 
 ### Description
 Specify arguments to a JavaScript runtime (e.g., `d8`), as opposed to the program.
@@ -32,6 +35,7 @@ Specify arguments to a JavaScript runtime (e.g., `d8`), as opposed to the progra
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple classpaths are space separated.
+Environment variables will be expanded.
 
 ### Description
 Append a list of classpaths to the existing classpaths.
@@ -41,17 +45,20 @@ Append a list of classpaths to the existing classpaths.
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple classpaths are space separated.
+Environment variables will be expanded.
 
 ### Description
 Prepend a list of classpaths to the existing classpaths.
 
 ## `JVMClasspath`
 A backward-compatibility alias of `JVMClasspathAppend`.
+Environment variables will be expanded.
 
 ## `ProgramArg`
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple arguments are space separated.
+Environment variables will be expanded.
 
 ### Description
 Specify arguments to a program, as opposed to the runtime.
@@ -68,6 +75,7 @@ That is, you can use `ModifierSet` recursively.
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple arguments are space separated.
+Environment variables will be expanded.
 
 ### Description
 Specify a wrapper.
@@ -87,3 +95,4 @@ If a companion program also exist for the benchmark suite you use, this companio
 ### Keys
 `val`: a single string with [shell-like syntax](https://docs.python.org/3/library/shlex.html#shlex.split).
 Multiple arguments are space separated.
+Environment variables will be expanded.
diff --git a/docs/src/references/runtime.md b/docs/src/references/runtime.md
@@ -13,20 +13,25 @@ tandem with
 ## `D8` (preview ⚠️)
 ### Keys
 `executable`: path to the `d8` executable.
+Environment variables will be expanded.
 
 ## `SpiderMonkey` (preview ⚠️)
 ### Keys
 `executable`: path to the `js` executable.
+Environment variables will be expanded.
 
 ## `JavaScriptCore` (preview ⚠️)
 ### Keys
 `executable`: path to the `jsc` executable.
+Environment variables will be expanded.
 
 ## `JuliaMMTK` (preview ⚠️)
 ### Keys
 `executable`: path to the `julia` executable.
+Environment variables will be expanded.
 
 ## `JuliaStock` (preview ⚠️)
 Julia with the stock GC. It does not allow setting a heap size, and will not throw OOM unless killed by the operating system.
 ### Keys
 `executable`: path to the `julia` executable.
+Environment variables will be expanded.
diff --git a/docs/src/references/suite.md b/docs/src/references/suite.md
@@ -28,6 +28,7 @@ The value is required.
 
 `path`: path to the DaCapo `jar`.
 The value is required.
+Environment variables will be expanded.
 
 `minheap`: a string that selects one of the `minheap_values` sets to use.
 
@@ -120,6 +121,7 @@ The value is required.
 `path`: path to the `jar`.
 The value is required.
 Note that the property file should reside in `path/../config/specjbb2015.props` per the standard folder structure of the ISO image provided by SPEC.
+Environment variables will be expanded.
 
 ### Benchmark Specification
 Only strings are allowed, which should correspond to the the mode of the SPECjbb2015 controller.
@@ -154,6 +156,7 @@ The value is required.
 
 `path`: path to the SPECjvm98 folder, where you can find `SpecApplication.class`.
 The value is required.
+Environment variables will be expanded.
 
 `timing_iteration`: specifying the timing iteration.
 It can only be a number, which is passed to SpecApplication as `-i`.
@@ -175,6 +178,7 @@ The following are the benchmarks:
 ### Keys
 `path`: path to the Octane benchmark folder.
 The value is required.
+Environment variables will be expanded.
 
 `wrapper`: path to the Octane wrapper written by Wenyu Zhao.
 The value is required.
@@ -206,6 +210,7 @@ GC benchmarks for Julia: https://github.com/JuliaCI/GCBenchmarks
 ### Keys
 `path`: path to the GCBenchmarks folder.
 The value is required.
+Environment variables will be expanded.
 
 `minheap`:  a string that selects one of the `minheap_values` sets to use.