diff options
author | ccalvarin <ccalvarin@google.com> | 2017-11-28 10:39:54 -0800 |
---|---|---|
committer | Copybara-Service <copybara-piper@google.com> | 2017-11-28 10:42:03 -0800 |
commit | a3cdd93430bf6e3eabed3016ba8850b762831a02 (patch) | |
tree | 1140974272070adbf2769e8de8bedf65e5f4529f /src/test/java/com/google/devtools/build/lib | |
parent | 6e978a3fe2c38c4a2dcfba27778c4961e1d38c9c (diff) |
Update blazerc documentation in the blaze/bazel user mannuals.
Update the docs for clarity and to explain the --expand_configs_in_place alternate expansion behavior.
RELNOTES: None.
PiperOrigin-RevId: 177183524
Diffstat (limited to 'src/test/java/com/google/devtools/build/lib')
-rw-r--r-- | src/test/java/com/google/devtools/build/lib/packages/util/DocumentationTestUtil.java | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/src/test/java/com/google/devtools/build/lib/packages/util/DocumentationTestUtil.java b/src/test/java/com/google/devtools/build/lib/packages/util/DocumentationTestUtil.java index c0126a870d..d3ad47badb 100644 --- a/src/test/java/com/google/devtools/build/lib/packages/util/DocumentationTestUtil.java +++ b/src/test/java/com/google/devtools/build/lib/packages/util/DocumentationTestUtil.java @@ -26,16 +26,13 @@ import com.google.devtools.build.lib.runtime.BuiltinCommandModule; import com.google.devtools.build.lib.runtime.ServerBuilder; import com.google.devtools.common.options.Options; import com.google.devtools.common.options.OptionsBase; - -import java.util.HashMap; +import java.util.HashSet; import java.util.List; -import java.util.Map; +import java.util.Set; import java.util.regex.Matcher; import java.util.regex.Pattern; -/** - * Utility functions for validating correctness of Bazel documentation. - */ +/** Utility functions for validating correctness of Bazel documentation. */ public abstract class DocumentationTestUtil { private DocumentationTestUtil() {} @@ -52,19 +49,23 @@ public abstract class DocumentationTestUtil { public static void validateUserManual( List<Class<? extends BlazeModule>> modules, ConfiguredRuleClassProvider ruleClassProvider, - String documentationSource) throws Exception { + String documentationSource) + throws Exception { // if there is a class missing, one can find it using // find . -name "*.java" -exec grep -Hn "@Option(name = " {} \; | grep "xxx" // where 'xxx' is a flag name. List<BlazeModule> blazeModules = BlazeRuntime.createModules(modules); - Map<String, Object> optionsMap = new HashMap<>(); + Set<String> validOptions = new HashSet<>(); // collect all startup options for (Class<? extends OptionsBase> optionsClass : BlazeCommandUtils.getStartupOptions(blazeModules)) { - optionsMap.putAll(Options.getDefaults(optionsClass).asMap()); + validOptions.addAll(Options.getDefaults(optionsClass).asMap().keySet()); } + // --bazelrc and --master_bazelrc are aliases for blaze equivalents. Add these explicitly. + validOptions.add("bazelrc"); + validOptions.add("master_bazelrc"); // collect all command options ServerBuilder serverBuilder = new ServerBuilder(); @@ -77,7 +78,7 @@ public abstract class DocumentationTestUtil { for (BlazeCommand command : blazeCommands) { for (Class<? extends OptionsBase> optionClass : BlazeCommandUtils.getOptions(command.getClass(), blazeModules, ruleClassProvider)) { - optionsMap.putAll(Options.getDefaults(optionClass).asMap()); + validOptions.addAll(Options.getDefaults(optionClass).asMap().keySet()); } } @@ -88,12 +89,12 @@ public abstract class DocumentationTestUtil { while (anchorMatcher.find()) { flag = anchorMatcher.group(1); - found = optionsMap.containsKey(flag); + found = validOptions.contains(flag); if (!found && flag.startsWith("no")) { - found = optionsMap.containsKey(flag.substring(2)); + found = validOptions.contains(flag.substring(2)); } if (!found && flag.startsWith("[no]")) { - found = optionsMap.containsKey(flag.substring(4)); + found = validOptions.contains(flag.substring(4)); } assertWithMessage("flag '" + flag + "' is not a blaze option (anymore)").that(found).isTrue(); |