Skip to content

Commit b9354d6

Browse files
authored
MINOR: Fix newline not working in LISTENERS_DOC (apache#18388)
Reviewers: Ken Huang <[email protected]>, PoAn Yang <[email protected]>, Chia-Ping Tsai <[email protected]>
1 parent bbcc297 commit b9354d6

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

server/src/main/java/org/apache/kafka/network/SocketServerConfigs.java

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,15 @@ public class SocketServerConfigs {
6565

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

8078
public static final String ADVERTISED_LISTENERS_CONFIG = "advertised.listeners";
8179
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 commit comments

Comments
 (0)