You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by rx...@apache.org on 2019/11/05 05:11:42 UTC
[pulsar] branch master updated: Fix docs about reset cursor (#5551)
This is an automated email from the ASF dual-hosted git repository.
rxl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 80e4b5f Fix docs about reset cursor (#5551)
80e4b5f is described below
commit 80e4b5f662acf92d743b24d795a84a7ba4005400
Author: 冉小龙 <ra...@gmail.com>
AuthorDate: Tue Nov 5 13:11:33 2019 +0800
Fix docs about reset cursor (#5551)
* Fix docs about reset cursor
Signed-off-by: xiaolong.ran <ra...@gmail.com>
* fix comments
Signed-off-by: xiaolong.ran <ra...@gmail.com>
---
.../src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java | 2 +-
site2/docs/reference-pulsar-admin.md | 6 ++++--
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
index 2df8d54..9a2ae1b 100644
--- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
+++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdTopics.java
@@ -500,7 +500,7 @@ public class CmdTopics extends CmdBase {
}
}
- @Parameters(commandDescription = "Reset position for subscription to position closest to timestamp or messageId")
+ @Parameters(commandDescription = "Reset position for subscription to a position that is closest to timestamp or messageId.")
private class ResetCursor extends CliCommand {
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;
diff --git a/site2/docs/reference-pulsar-admin.md b/site2/docs/reference-pulsar-admin.md
index 9bc05c2..d964427 100644
--- a/site2/docs/reference-pulsar-admin.md
+++ b/site2/docs/reference-pulsar-admin.md
@@ -1978,7 +1978,7 @@ Options
### `reset-cursor`
-Reset position for subscription to closest to timestamp
+Reset position for subscription to a position that is closest to timestamp or messageId.
Usage
```bash
@@ -1986,10 +1986,12 @@ $ pulsar-admin topics reset-cursor topic options
```
Options
+
|Flag|Description|Default|
|---|---|---|
|`-s`, `--subscription`|Subscription to reset position on||
-|`-t`, `--time`|The time, in minutes, to reset back to (or minutes, hours, days, weeks, etc.). Examples: `100m`, `3h`, `2d`, `5w`.||
+|`-t`, `--time`|The time in minutes to reset back to (or minutes, hours, days, weeks, etc.). Examples: `100m`, `3h`, `2d`, `5w`.||
+|`-m`, `--messageId`| The messageId to reset back to (ledgerId:entryId). ||