You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/11/26 09:32:55 UTC
[GitHub] [pulsar] ericsyh opened a new pull request #12989: fix(docs): incorrect command name and description for autorecovery
ericsyh opened a new pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989
Signed-off-by: Eric Shen <er...@outlook.com>
<!--
### Contribution Checklist
- Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
Skip *Issue XYZ* if there is no associated github issue for this pull request.
Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
### Motivation
The command name and description of `bin/bookkeeper autorecovery` are not correct on docs now:
* The command should be `bin/bookkeeper autorecovery` rather than `bin/bookkeeper auto-recovery`
* The command `bin/bookkeeper autorecovery` won't start autorecovery in daemon, PTAL the fix PR https://github.com/apache/bookkeeper/pull/2910. The daemon command is not supported on `bin/pulsar-daemon`, so i submitted a PR for it: https://github.com/apache/pulsar/pull/12985
### Modifications
* Changed the command name from `bin/bookkeeper auto-recovery` to `bin/bookkeeper autorecovery` on related docs.
* Changed the command description.
### Verifying this change
- [x] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (10MB)*
- *Extended integration test for recovery after broker failure*
### Does this pull request potentially affect one of the following parts:
*If `yes` was chosen, please highlight the changes*
- Dependencies (does it add or upgrade a dependency): (no)
- The public API: (no)
- The schema: (no)
- The default values of configurations: (no)
- The wire protocol: (no)
- The rest endpoints: (no)
- The admin cli options: (no)
- Anything that affects deployment: (no)
### Documentation
Check the box below and label this PR (if you have committer privilege).
Need to update docs?
- [ ] `doc-required`
(If you need help on updating docs, create a doc issue)
- [ ] `no-need-doc`
(Please explain why)
- [x] `doc`
(If this PR contains doc changes)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#issuecomment-988426376
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#discussion_r761707341
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -734,9 +734,9 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery daemon||
+|`-c`, `--conf`|Configuration for the auto-recovery||
|-readOnly|Force start a read-only bookie server|false|
-|-withAutoRecovery|Start auto-recovery service bookie server|false|
+|-withAutoRecovery|Start autorecovery service bookie server|false|
Review comment:
Do you miss this one? (and many other places)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#discussion_r760905688
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -707,19 +707,19 @@ The table below lists the environment variables that you can use to configure th
|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
-### `auto-recovery`
-Runs an auto-recovery service daemon
+### `autorecovery`
+Runs an auto-recovery service
Usage
```bash
-$ bookkeeper auto-recovery options
+$ bookkeeper autorecovery options
```
Options
|Flag|Description|Default|
|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery daemon||
+|`-c`, `--conf`|Configuration for the autorecovery||
Review comment:
`auto-recovery` (or `auto recovery`) is a correct word in the description, why modify that?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on a change in pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
ericsyh commented on a change in pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#discussion_r761721764
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -734,9 +734,9 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery daemon||
+|`-c`, `--conf`|Configuration for the auto-recovery||
|-readOnly|Force start a read-only bookie server|false|
-|-withAutoRecovery|Start auto-recovery service bookie server|false|
+|-withAutoRecovery|Start autorecovery service bookie server|false|
Review comment:
Ok i will take a full check on it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on a change in pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
ericsyh commented on a change in pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#discussion_r761645981
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -707,19 +707,19 @@ The table below lists the environment variables that you can use to configure th
|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
-### `auto-recovery`
-Runs an auto-recovery service daemon
+### `autorecovery`
+Runs an auto-recovery service
Usage
```bash
-$ bookkeeper auto-recovery options
+$ bookkeeper autorecovery options
```
Options
|Flag|Description|Default|
|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery daemon||
+|`-c`, `--conf`|Configuration for the autorecovery||
Review comment:
OK, I updated in https://github.com/apache/pulsar/pull/12989/commits/94ebed6125a68ce3c235b3e30abf7bbdf7bba3ea
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#discussion_r760902478
##########
File path: bin/bookkeeper
##########
@@ -88,7 +88,7 @@ bookkeeper_help() {
Usage: bookkeeper <command>
where command is one of:
bookie Run a bookie server
- autorecovery Run AutoRecovery service daemon
+ autorecovery Run AutoRecovery service
Review comment:
Hi @BewareMyPower can you review this from the technical perspective? Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a change in pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#discussion_r760980934
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -707,19 +707,19 @@ The table below lists the environment variables that you can use to configure th
|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
-### `auto-recovery`
-Runs an auto-recovery service daemon
+### `autorecovery`
+Runs an auto-recovery service
Usage
```bash
-$ bookkeeper auto-recovery options
+$ bookkeeper autorecovery options
```
Options
|Flag|Description|Default|
|---|---|---|
-|`-c`, `--conf`|Configuration for the auto-recovery daemon||
+|`-c`, `--conf`|Configuration for the autorecovery||
Review comment:
I agree, we should keep the `auto-recovery` term.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
ericsyh commented on pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989#issuecomment-983657210
@Anonymitaet PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #12989: fix(docs): incorrect command name and description for autorecovery
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #12989:
URL: https://github.com/apache/pulsar/pull/12989
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org