This is an automated email from the ASF dual-hosted git repository. manikumar pushed a commit to branch trunk in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push: new 59c1d4e MINOR: Generator config-specific HTML ids (#8878) 59c1d4e is described below commit 59c1d4ece309311dc670c280eea37953049ed19d Author: Tom Bentley <tombent...@users.noreply.github.com> AuthorDate: Sat Sep 19 12:35:13 2020 +0100 MINOR: Generator config-specific HTML ids (#8878) Currently the docs have HTML ids for each config key. That doesn't work correctly for config keys like bootstrap.servers which occur across producer, consumer, admin configs: We generate duplicate ids. So arrange for each config to prefix the ids it generates with the HTML id of its section heading. Reviewers: Mickael Maison <mickael.mai...@gmail.com>, Manikumar Reddy <manikumar.re...@gmail.com> --- .../main/java/org/apache/kafka/clients/admin/AdminClientConfig.java | 2 +- .../main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java | 2 +- .../main/java/org/apache/kafka/clients/producer/ProducerConfig.java | 2 +- clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java | 2 +- .../java/org/apache/kafka/connect/runtime/SinkConnectorConfig.java | 2 +- .../org/apache/kafka/connect/runtime/SourceConnectorConfig.java | 2 +- .../apache/kafka/connect/runtime/distributed/DistributedConfig.java | 2 +- core/src/main/scala/kafka/log/LogConfig.scala | 2 +- core/src/main/scala/kafka/server/KafkaConfig.scala | 3 ++- core/src/test/scala/unit/kafka/log/LogConfigTest.scala | 6 +++--- streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java | 2 +- 11 files changed, 14 insertions(+), 13 deletions(-) diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java b/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java index 2b6af1f..c775faa 100644 --- a/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java +++ b/clients/src/main/java/org/apache/kafka/clients/admin/AdminClientConfig.java @@ -248,7 +248,7 @@ public class AdminClientConfig extends AbstractConfig { } public static void main(String[] args) { - System.out.println(CONFIG.toHtml()); + System.out.println(CONFIG.toHtml(4, config -> "adminclientconfigs_" + config)); } } diff --git a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java index 246e06f..c90bac5 100644 --- a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java +++ b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java @@ -650,7 +650,7 @@ public class ConsumerConfig extends AbstractConfig { } public static void main(String[] args) { - System.out.println(CONFIG.toHtml()); + System.out.println(CONFIG.toHtml(4, config -> "consumerconfigs_" + config)); } } diff --git a/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java b/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java index 4600270..3e399c0 100644 --- a/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java +++ b/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java @@ -564,7 +564,7 @@ public class ProducerConfig extends AbstractConfig { } public static void main(String[] args) { - System.out.println(CONFIG.toHtml()); + System.out.println(CONFIG.toHtml(4, config -> "producerconfigs_" + config)); } } diff --git a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java index 1e51758..5137bf1 100644 --- a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java +++ b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java @@ -1534,7 +1534,7 @@ public class ConfigDef { } b.append("<li>\n"); b.append(String.format("<h%1$d>" + - "<a id=\"%2$s\" href=\"#%2$s\">%3$s</a>" + + "<a id=\"%3$s\"></a><a id=\"%2$s\" href=\"#%2$s\">%3$s</a>" + "</h%1$d>%n", headerDepth, idGenerator.apply(key.name), key.name)); b.append("<p>"); b.append(key.documentation.replaceAll("\n", "<br>")); diff --git a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SinkConnectorConfig.java b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SinkConnectorConfig.java index e224e3d..415d46f 100644 --- a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SinkConnectorConfig.java +++ b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SinkConnectorConfig.java @@ -169,6 +169,6 @@ public class SinkConnectorConfig extends ConnectorConfig { } public static void main(String[] args) { - System.out.println(config.toHtml()); + System.out.println(config.toHtml(4, config -> "sinkconnectorconfigs_" + config)); } } diff --git a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SourceConnectorConfig.java b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SourceConnectorConfig.java index fc5832a..7cf5d67 100644 --- a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SourceConnectorConfig.java +++ b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/SourceConnectorConfig.java @@ -181,6 +181,6 @@ public class SourceConnectorConfig extends ConnectorConfig { } public static void main(String[] args) { - System.out.println(config.toHtml()); + System.out.println(config.toHtml(4, config -> "sourceconnectorconfigs_" + config)); } } diff --git a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/distributed/DistributedConfig.java b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/distributed/DistributedConfig.java index 0a072ff..0823fbc 100644 --- a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/distributed/DistributedConfig.java +++ b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/distributed/DistributedConfig.java @@ -408,7 +408,7 @@ public class DistributedConfig extends WorkerConfig { } public static void main(String[] args) { - System.out.println(CONFIG.toHtml()); + System.out.println(CONFIG.toHtml(4, config -> "connectconfigs_" + config)); } public KeyGenerator getInternalRequestKeyGenerator() { diff --git a/core/src/main/scala/kafka/log/LogConfig.scala b/core/src/main/scala/kafka/log/LogConfig.scala index 8b29979..c0a6d9f 100755 --- a/core/src/main/scala/kafka/log/LogConfig.scala +++ b/core/src/main/scala/kafka/log/LogConfig.scala @@ -113,7 +113,7 @@ case class LogConfig(props: java.util.Map[_, _], overriddenConfigs: Set[String] object LogConfig { def main(args: Array[String]): Unit = { - println(configDef.toHtml) + println(configDef.toHtml(4, (config: String) => "topicconfigs_" + config)) } val SegmentBytesProp = TopicConfig.SEGMENT_BYTES_CONFIG diff --git a/core/src/main/scala/kafka/server/KafkaConfig.scala b/core/src/main/scala/kafka/server/KafkaConfig.scala index 25a1cb9..e7190fb 100755 --- a/core/src/main/scala/kafka/server/KafkaConfig.scala +++ b/core/src/main/scala/kafka/server/KafkaConfig.scala @@ -271,7 +271,8 @@ object KafkaConfig { private val LogConfigPrefix = "log." def main(args: Array[String]): Unit = { - System.out.println(configDef.toHtml(DynamicBrokerConfig.dynamicConfigUpdateModes)) + System.out.println(configDef.toHtml(4, (config: String) => "brokerconfigs_" + config, + DynamicBrokerConfig.dynamicConfigUpdateModes)) } /** ********* Zookeeper Configuration ***********/ diff --git a/core/src/test/scala/unit/kafka/log/LogConfigTest.scala b/core/src/test/scala/unit/kafka/log/LogConfigTest.scala index 809b5df..09f4503 100644 --- a/core/src/test/scala/unit/kafka/log/LogConfigTest.scala +++ b/core/src/test/scala/unit/kafka/log/LogConfigTest.scala @@ -17,7 +17,7 @@ package kafka.log -import java.util.Properties +import java.util.{Collections, Properties} import kafka.server.{KafkaConfig, KafkaServer, ThrottledReplicaListValidator} import kafka.utils.TestUtils @@ -126,8 +126,8 @@ class LogConfigTest { /* Sanity check that toHtml produces one of the expected configs */ @Test def testToHtml(): Unit = { - val html = LogConfig.configDefCopy.toHtml - val expectedConfig = "<h4><a id=\"file.delete.delay.ms\" href=\"#file.delete.delay.ms\">file.delete.delay.ms</a></h4>" + val html = LogConfig.configDefCopy.toHtml(4, (key: String) => "prefix_" + key, Collections.emptyMap()) + val expectedConfig = "<h4><a id=\"file.delete.delay.ms\"></a><a id=\"prefix_file.delete.delay.ms\" href=\"#prefix_file.delete.delay.ms\">file.delete.delay.ms</a></h4>" assertTrue(s"Could not find `$expectedConfig` in:\n $html", html.contains(expectedConfig)) } diff --git a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java index a8cfc01..dc34f9a 100644 --- a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java +++ b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java @@ -1438,6 +1438,6 @@ public class StreamsConfig extends AbstractConfig { } public static void main(final String[] args) { - System.out.println(CONFIG.toHtml()); + System.out.println(CONFIG.toHtml(4, config -> "streamsconfigs_" + config)); } }