From 1d5ec83a13b6787996fbcf9f556b89481f5b55b6 Mon Sep 17 00:00:00 2001 From: hrsakai <hsakai@yahoo-corp.jp> Date: Sat, 11 Mar 2017 03:18:08 +0900 Subject: [PATCH] amend some typographic errors in documents (#286) --- docs/AdminTools.md | 22 +++++++--------------- docs/BinaryProtocol.md | 2 +- docs/ClusterSetup.md | 4 ++-- docs/GeoReplication.md | 2 +- docs/WebSocket.md | 2 +- 5 files changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/AdminTools.md b/docs/AdminTools.md index 66690fe6dd366..af54d33e27384 100644 --- a/docs/AdminTools.md +++ b/docs/AdminTools.md @@ -663,7 +663,7 @@ admin.clusters().deleteCluster(cluster) #### list all clusters -It gives a list of call created clusters in Pulsar system. +It gives a list of all created clusters in Pulsar system. ###### CLI @@ -2386,10 +2386,6 @@ In your terminal, go to below directory to play with client tool. <td>```-m, --messages```</td> <td>```Comma separted string messages to send. Cannot be used with -f. Either -m or -f must be provided```</td> </tr> - <tr> - <td>```-np, --non-persistent```</td> - <td>```Produce non-persistent message, Default: false```</td> - </tr> <tr> <td>```-n, --num-produce```</td> <td>```Number of times to send message(s), Default: 1```</td> @@ -2398,10 +2394,6 @@ In your terminal, go to below directory to play with client tool. <td>```-r, --rate```</td> <td>```Rate (in msg/sec) at which to produce. Value of 0 will produce messages as fast as possible, Default: 0.0```</td> </tr> - <tr> - <td>```--ttl```</td> - <td>```Time to live (in ms) for the messages. Value of 0 will result in unlimited TTL, Default: 3600000```</td> - </tr> <table> #### consume message command @@ -2414,10 +2406,6 @@ In your terminal, go to below directory to play with client tool. <th>options</th> <th>description</th> </tr> - <tr> - <td>```-c, --client-id```</td> - <td>```Client ID for subscriber connection. Required if subscriber ID also specified```</td> - </tr> <tr> <td>```--hex```</td> <td>```Display binary messages in hex, Default: false```</td> @@ -2431,7 +2419,11 @@ In your terminal, go to below directory to play with client tool. <td>```Rate (in msg/sec) at which to consume. Value of 0 will consume messages as fast as possible, Default: 0.0```</td> </tr> <tr> - <td>```-s, --subscriber-id```</td> - <td>```Subscriber ID for a durable subscriber```</td> + <td>```-s, --subscription-name```</td> + <td>```Subscription name```</td> + </tr> + <tr> + <td>```-t, --subscription-type```</td> + <td>```Subscription type: Exclusive, Shared, Failover, Default: Exclusive```</td> </tr> <table> diff --git a/docs/BinaryProtocol.md b/docs/BinaryProtocol.md index 60447f374fe9a..d8ec1fd6dd247 100644 --- a/docs/BinaryProtocol.md +++ b/docs/BinaryProtocol.md @@ -34,7 +34,7 @@ Commands for different producers and consumers can be interleaved and sent through the same connection without any restriction. All the commands are embedded in a -[`BaseCommand`](https://github.com/yahoo/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto#L283) +[`BaseCommand`](https://github.com/yahoo/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto#L335) protobuf object that includes a type enum and all the possible sub-commands as optional fields. At any time, one `BaseCommand` can only have set a single sub-command. diff --git a/docs/ClusterSetup.md b/docs/ClusterSetup.md index 305a3e825ab72..5520d75e4a627 100644 --- a/docs/ClusterSetup.md +++ b/docs/ClusterSetup.md @@ -190,7 +190,7 @@ zkServers=zk1.example.com:2181,zk2.example.com:2181,zk3.example.com:2181 ledgerManagerType=hierarchical ``` -Please consult [http://bookkeeper.apache.org/]() for more extensive documentation +Please consult http://bookkeeper.apache.org/ for more extensive documentation on Apache BookKeeper. ##### Starting the service @@ -317,7 +317,7 @@ for messages: $ bin/pulsar-perf consume persistent://test/us-west/ns1/my-topic ``` -Start a produce that publishes messages at a fixed rate and report stats every +Start a producer that publishes messages at a fixed rate and report stats every 10 seconds: ```shell diff --git a/docs/GeoReplication.md b/docs/GeoReplication.md index 134ddbbd2ec2a..8a7cb0b14f15d 100644 --- a/docs/GeoReplication.md +++ b/docs/GeoReplication.md @@ -6,7 +6,7 @@ - [Replication model](#replication-model) - [Configuring replication](#configuring-replication) - [Granting permissions to properties](#granting-permissions-to-properties) - - [Creating the namespace](#creating-the-namespace) + - [Creating global namespaces](#creating-global-namespaces) - [Using global topics](#using-global-topics) <!-- /TOC --> diff --git a/docs/WebSocket.md b/docs/WebSocket.md index 7b15590075d55..bdf6ff5232482 100644 --- a/docs/WebSocket.md +++ b/docs/WebSocket.md @@ -121,7 +121,7 @@ http://{serviceUrl}:8080/ws/producer/persistent/{property}/{cluster}/{namespace} ### Consumer -Open a WebSocket session to create a producer for a specific topic: +Open a WebSocket session to create a consumer for a specific topic: ```perl http://{serviceUrl}:8080/ws/consumer/persistent/{property}/{cluster}/{namespace}/{topic}/{subscription}