This is an automated email from the ASF dual-hosted git repository.
szetszwo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ratis.git
The following commit(s) were added to refs/heads/master by this push:
new bf415182f [RATIS-1805] Add doc about GENERIC_COMMAND_OPTIONS of
ratis-shell (#840)
bf415182f is described below
commit bf415182ff04848c4c14b759d43c668e95920517
Author: Angerszhuuuu <[email protected]>
AuthorDate: Mon Mar 6 03:49:43 2023 +0800
[RATIS-1805] Add doc about GENERIC_COMMAND_OPTIONS of ratis-shell (#840)
---
ratis-docs/src/site/markdown/cli.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/ratis-docs/src/site/markdown/cli.md
b/ratis-docs/src/site/markdown/cli.md
index 25ebd3558..75be20c12 100644
--- a/ratis-docs/src/site/markdown/cli.md
+++ b/ratis-docs/src/site/markdown/cli.md
@@ -82,6 +82,16 @@ Usage: ratis sh [generic options]
[snapshot [create]]
```
+## generic options
+The `generic options` supports the following content:
+`-D*`, `-X*`, `-agentlib*`, `-javaagent*`
+
+The `-D*` can pass values for a given ratis property to ratis-shell client
RaftProperties.
+
+```
+$ ratis sh -D<property=value> ...
+```
+
## election
The `election` command manages leader election.
It has the following subcommands:
