Skip to content

Commit

Permalink
MINOR: Fix newline not working in LISTENERS_DOC (#18388)
Browse files Browse the repository at this point in the history
Reviewers: Ken Huang <s7133700@gmail.com>, PoAn Yang <payang@apache.org>, Chia-Ping Tsai <chia7712@gmail.com>
clarkwtc authored Jan 6, 2025
1 parent bbcc297 commit b9354d6
Showing 1 changed file with 9 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -65,17 +65,15 @@ public class SocketServerConfigs {

public static final String LISTENERS_CONFIG = "listeners";
public static final String LISTENERS_DEFAULT = "PLAINTEXT://:9092";
public static final String LISTENERS_DOC = "Listener List - Comma-separated list of URIs we will listen on and the listener names." +
String.format(" If the listener name is not a security protocol, <code>%s</code> must also be set.%n", LISTENER_SECURITY_PROTOCOL_MAP_CONFIG) +
" Listener names and port numbers must be unique unless %n" +
" one listener is an IPv4 address and the other listener is %n" +
" an IPv6 address (for the same port).%n" +
" Specify hostname as 0.0.0.0 to bind to all interfaces.%n" +
" Leave hostname empty to bind to default interface.%n" +
" Examples of legal listener lists:%n" +
" <code>PLAINTEXT://myhost:9092,SSL://:9091</code>%n" +
" <code>CLIENT://0.0.0.0:9092,REPLICATION://localhost:9093</code>%n" +
" <code>PLAINTEXT://127.0.0.1:9092,SSL://[::1]:9092</code>%n";
public static final String LISTENERS_DOC = String.format("Listener List - Comma-separated list of URIs we will listen on and the listener names." +
" If the listener name is not a security protocol, <code>%s</code> must also be set.%n" +
" Listener names and port numbers must be unique unless one listener is an IPv4 address and the other listener is an IPv6 address (for the same port).%n" +
" Specify hostname as 0.0.0.0 to bind to all interfaces.%n" +
" Leave hostname empty to bind to default interface.%n" +
" Examples of legal listener lists:%n" +
" <code>PLAINTEXT://myhost:9092,SSL://:9091</code>%n" +
" <code>CLIENT://0.0.0.0:9092,REPLICATION://localhost:9093</code>%n" +
" <code>PLAINTEXT://127.0.0.1:9092,SSL://[::1]:9092</code>%n", LISTENER_SECURITY_PROTOCOL_MAP_CONFIG);

public static final String ADVERTISED_LISTENERS_CONFIG = "advertised.listeners";
public static final String ADVERTISED_LISTENERS_DOC = String.format("Specifies the listener addresses that the Kafka brokers will advertise to clients and other brokers." +

0 comments on commit b9354d6

Please sign in to comment.