aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/skylarkbuildapi
diff options
context:
space:
mode:
authorGravatar Googler <noreply@google.com>2018-08-02 12:10:56 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-08-02 12:12:38 -0700
commit981801542dc0db6a0df9be7cfee075ec841a6cd0 (patch)
tree7c93e57c0511912743e1d8974f1fe92a5dc03024 /src/main/java/com/google/devtools/build/lib/skylarkbuildapi
parent202bf260cce05487757ff5714d38e04a704b39af (diff)
Clarifies the documentation for action.args() set_param_file_format.
The way documentation reads, it sounds like 'shell' format is single line (especially because the other format is called multiline). Currently it seems like the implementation only uses new line but assuming Bazel doesn't want to promise on that, this patch updates the documentation to point that whitespace could be space, tab or newline - which mimics the documentation of ParameterFileType.SHELL_QUOTED. RELNOTES: None. PiperOrigin-RevId: 207142679
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/skylarkbuildapi')
-rw-r--r--src/main/java/com/google/devtools/build/lib/skylarkbuildapi/CommandLineArgsApi.java2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/CommandLineArgsApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/CommandLineArgsApi.java
index a8d6bdec2a..1a95b34612 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/CommandLineArgsApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/CommandLineArgsApi.java
@@ -512,7 +512,7 @@ public interface CommandLineArgsApi extends SkylarkValue {
doc =
"The format of the param file. Must be one of:<ul><li>"
+ "\"shell\": All arguments are shell quoted and separated by "
- + "whitespace</li><li>"
+ + "whitespace (space, tab, newline)</li><li>"
+ "\"multiline\": All arguments are unquoted and separated by newline "
+ "characters</li></ul>"
+ "<p>The format defaults to \"shell\" if not called.")