root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

MINOR: Fix config documentation formatting (#12921) 

Reviewers: José Armando García Sancio <jsancio@apache.org>
This commit is contained in:
Joel Hamill 2022-11-30 08:54:39 -08:00 committed by GitHub
parent 548348c9e7
commit d9946a7ffc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
clients/src/main/java/org/apache/kafka/common/config/internals/BrokerSecurityConfigs.java
View File

@ -61,10 +61,10 @@ public class BrokerSecurityConfigs {
public static final String SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES_DOC = "A list of rules for mapping from principal " +
"names to short names (typically operating system usernames). The rules are evaluated in order and the " +
"first rule that matches a principal name is used to map it to a short name. Any later rules in the list are " +
"ignored. By default, principal names of the form {username}/{hostname}@{REALM} are mapped to {username}. " +
"For more details on the format please see <a href=\"#security_authz\"> security authorization and acls</a>. " +
"Note that this configuration is ignored if an extension of KafkaPrincipalBuilder is provided by the " +
"<code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
"ignored. By default, principal names of the form <code>{username}/{hostname}@{REALM}</code> are mapped " +
"to <code>{username}</code>. For more details on the format please see <a href=\"#security_authz\"> " +
"security authorization and acls</a>. Note that this configuration is ignored if an extension of " +
"<code>KafkaPrincipalBuilder</code> is provided by the <code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
public static final List<String> DEFAULT_SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES = Collections.singletonList("DEFAULT");
public static final String SSL_CLIENT_AUTH_DOC = "Configures kafka broker to request client authentication."

4
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
View File

@ -481,7 +481,7 @@ public class StreamsConfig extends AbstractConfig {
@SuppressWarnings("WeakerAccess")
public static final String CLIENT_ID_CONFIG = CommonClientConfigs.CLIENT_ID_CONFIG;
private static final String CLIENT_ID_DOC = "An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer," +
" with pattern '<client.id>-StreamThread-<threadSequenceNumber>-<consumer|producer|restore-consumer>'.";
" with pattern <code>&lt;client.id&gt;-StreamThread-&lt;threadSequenceNumber$gt;-&lt;consumer|producer|restore-consumer&gt;</code>.";
/** {@code commit.interval.ms} */
@SuppressWarnings("WeakerAccess")
@ -543,7 +543,7 @@ public class StreamsConfig extends AbstractConfig {
/** {@code default key.serde} */
@SuppressWarnings("WeakerAccess")
public static final String DEFAULT_KEY_SERDE_CLASS_CONFIG = "default.key.serde";
private static final String DEFAULT_KEY_SERDE_CLASS_DOC = " Default serializer / deserializer class for key that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface. "
private static final String DEFAULT_KEY_SERDE_CLASS_DOC = "Default serializer / deserializer class for key that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface. "
+ "Note when windowed serde class is used, one needs to set the inner serde class that implements the <code>org.apache.kafka.common.serialization.Serde</code> interface via '"
+ DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS + "' or '" + DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS + "' as well";