summaryrefslogtreecommitdiff
path: root/java/com/google/devtools/common/options/OptionsProvider.java
diff options
context:
space:
mode:
authorIvan Gavrilovic <gavra@google.com>2018-05-08 02:26:09 -0700
committerandroid-build-merger <android-build-merger@google.com>2018-05-08 02:26:09 -0700
commit2b50d295f5acc8ddf8924cd6536dfbfe45965ade (patch)
tree74deac1e16e97c2c13f226cd4635cd65abf19303 /java/com/google/devtools/common/options/OptionsProvider.java
parent301a69dfe6fbb59072b6c1af278ec31c10cbdf35 (diff)
parent6beb00b4744298d2ef28b6590c31b6848885b28d (diff)
downloaddesugar-2b50d295f5acc8ddf8924cd6536dfbfe45965ade.tar.gz
Merge remote-tracking branch upstream-master into master am: 9d2aa11004android-o-mr1-iot-release-1.0.4android-o-mr1-iot-release-1.0.3
am: 6beb00b474 Change-Id: I5f801929d952fac02c0b652fb9003295f4bf7820
Diffstat (limited to 'java/com/google/devtools/common/options/OptionsProvider.java')
-rw-r--r--java/com/google/devtools/common/options/OptionsProvider.java12
1 files changed, 7 insertions, 5 deletions
diff --git a/java/com/google/devtools/common/options/OptionsProvider.java b/java/com/google/devtools/common/options/OptionsProvider.java
index d467fe5..ece5d5d 100644
--- a/java/com/google/devtools/common/options/OptionsProvider.java
+++ b/java/com/google/devtools/common/options/OptionsProvider.java
@@ -73,11 +73,13 @@ public interface OptionsProvider extends OptionsClassProvider {
List<OptionValueDescription> asListOfOptionValues();
/**
- * Canonicalizes the list of options that this OptionsParser has parsed. The
- * contract is that if the returned set of options is passed to an options
- * parser with the same options classes, then that will have the same effect
- * as using the original args (which are passed in here), except for cosmetic
- * differences.
+ * Canonicalizes the list of options that this OptionsParser has parsed.
+ *
+ * <p>The contract is that if the returned set of options is passed to an options parser with the
+ * same options classes, then that will have the same effect as using the original args (which are
+ * passed in here), except for cosmetic differences. We do not guarantee that the 'canonical' list
+ * is unique, since some flags may have effects unknown to the parser (--config, for Bazel), so we
+ * do not reorder flags to further simplify the list.
*/
List<String> canonicalize();
}