[hotfix][docs][conf] Log included packages / excluded classes

Eases discoverability
is · Feb 15, 2020 · 47a1725 · 47a1725
1 parent a589467
commit 47a1725
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/flink-docs/src/main/java/org/apache/flink/docs/configuration/ConfigOptionsDocGenerator.java b/flink-docs/src/main/java/org/apache/flink/docs/configuration/ConfigOptionsDocGenerator.java
@@ -116,6 +116,13 @@ public static void main(String[] args) throws IOException, ClassNotFoundExceptio
  String outputDirectory = args[0];
  String rootDir = args[1];
 
+ LOG.info("Searching the following locations; configured via {}#LOCATIONS:{}",
+ ConfigOptionsDocGenerator.class.getCanonicalName(),
+ Arrays.stream(LOCATIONS).map(OptionsClassLocation::toString).collect(Collectors.joining("\n\t", "\n\t", "")));
+ LOG.info("Excluding the following classes; configured via {}#EXCLUSIONS:{}",
+ ConfigOptionsDocGenerator.class.getCanonicalName(),
+ EXCLUSIONS.stream().collect(Collectors.joining("\n\t", "\n\t", "")));
+
  for (OptionsClassLocation location : LOCATIONS) {
  createTable(rootDir, location.getModule(), location.getPackage(), outputDirectory, DEFAULT_PATH_PREFIX);
  }

diff --git a/flink-docs/src/main/java/org/apache/flink/docs/configuration/OptionsClassLocation.java b/flink-docs/src/main/java/org/apache/flink/docs/configuration/OptionsClassLocation.java
@@ -39,4 +39,9 @@ public String getModule() {
  public String getPackage() {
  return pckg;
  }
+
+ @Override
+ public String toString() {
+ return module + "#" + pckg;
+ }
 }