aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java
diff options
context:
space:
mode:
authorGravatar jmmv <jmmv@google.com>2017-09-06 17:27:13 +0200
committerGravatar Yun Peng <pcloudy@google.com>2017-09-07 09:57:10 +0200
commit313a0e04eb7c173359b1e18a6cbe5dd5915bb0a8 (patch)
tree01ea3d06385aaf3703099211eb6e7b489297bead /src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java
parent1926b519113328c5041fd1044592f030d7580385 (diff)
Remove the product name from ConfiguredRuleClassProvider.
The RuleClassProvider includes a copy of the product name, parameterized for both Blaze and Bazel. Apparently, this is exclusively there so that the standalone docgen binary can "magically" guess the product name. This is strange and adds additional complexity to the Bazel core codebase for no strong reason. Instead, just add a new flag to docgen that takes the product name and pass it in explicitly. RELNOTES: None. PiperOrigin-RevId: 167724033
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java b/src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java
index 56f7d29386..395455bba2 100644
--- a/src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java
+++ b/src/main/java/com/google/devtools/build/docgen/SinglePageBuildEncyclopediaProcessor.java
@@ -24,8 +24,9 @@ import java.util.Map;
* Assembles the single-page version of the Build Encyclopedia.
*/
public class SinglePageBuildEncyclopediaProcessor extends BuildEncyclopediaProcessor {
- public SinglePageBuildEncyclopediaProcessor(ConfiguredRuleClassProvider ruleClassProvider) {
- super(ruleClassProvider);
+ public SinglePageBuildEncyclopediaProcessor(
+ String productName, ConfiguredRuleClassProvider ruleClassProvider) {
+ super(productName, ruleClassProvider);
}
/**
@@ -39,8 +40,8 @@ public class SinglePageBuildEncyclopediaProcessor extends BuildEncyclopediaProce
@Override
public void generateDocumentation(List<String> inputDirs, String outputDir, String blackList)
throws BuildEncyclopediaDocException, IOException {
- BuildDocCollector collector = new BuildDocCollector(ruleClassProvider, false);
- RuleLinkExpander expander = new RuleLinkExpander(ruleClassProvider.getProductName(), true);
+ BuildDocCollector collector = new BuildDocCollector(productName, ruleClassProvider, false);
+ RuleLinkExpander expander = new RuleLinkExpander(productName, true);
Map<String, RuleDocumentation> ruleDocEntries = collector.collect(
inputDirs, blackList, expander);
warnAboutUndocumentedRules(