Skip to content

Commit 7e02946

Browse files
idryomovidryomov
committed
rbd: mention namespace in "rbd mirror pool" command descriptions
Commit 5e64748 ("doc/rbd: add namespace information for mirror commands") did this for the man page, update the built-in help as well. The "by default" bit in the description of "rbd mirror pool enable" and "rbd mirror pool disable" commands is specific to pool mode which is in turn specific to journal-based mirroring, so it's removed. Signed-off-by: Ilya Dryomov <[email protected]>
1 parent 5f064a5 commit 7e02946

File tree

2 files changed

+24
-23
lines changed

2 files changed

+24
-23
lines changed

‎src/test/cli/rbd/help.t‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -97,24 +97,25 @@
9797
mirroring.
9898
mirror image snapshot Create RBD mirroring image snapshot.
9999
mirror image status Show RBD mirroring status for an image.
100-
mirror pool demote Demote all primary images in the pool.
101-
mirror pool disable Disable RBD mirroring by default within a
102-
pool.
103-
mirror pool enable Enable RBD mirroring by default within a
104-
pool.
105-
mirror pool info Show information about the pool mirroring
106-
configuration.
100+
mirror pool demote Demote all primary images in a pool or
101+
namespace.
102+
mirror pool disable Disable RBD mirroring in a pool or
103+
namespace.
104+
mirror pool enable Enable RBD mirroring in a pool or
105+
namespace.
106+
mirror pool info Show mirroring configuration for a pool
107+
or namespace.
107108
mirror pool peer add Add a mirroring peer to a pool.
108109
mirror pool peer bootstrap create Create a peer bootstrap token to import
109110
in a remote cluster
110111
mirror pool peer bootstrap import Import a peer bootstrap token created
111112
from a remote cluster
112113
mirror pool peer remove Remove a mirroring peer from a pool.
113114
mirror pool peer set Update mirroring peer settings.
114-
mirror pool promote Promote all non-primary images in the
115-
pool.
116-
mirror pool status Show status for all mirrored images in
117-
the pool.
115+
mirror pool promote Promote all non-primary images in a pool
116+
or namespace.
117+
mirror pool status Show status for all mirrored images in a
118+
pool or namespace.
118119
mirror snapshot schedule add Add mirror snapshot schedule.
119120
mirror snapshot schedule list (... ls)
120121
List mirror snapshot schedule.
@@ -1804,7 +1805,7 @@
18041805
usage: rbd mirror pool demote [--pool <pool>] [--namespace <namespace>]
18051806
<pool-spec>
18061807

1807-
Demote all primary images in the pool.
1808+
Demote all primary images in a pool or namespace.
18081809

18091810
Positional arguments
18101811
<pool-spec> pool specification
@@ -1818,7 +1819,7 @@
18181819
usage: rbd mirror pool disable [--pool <pool>] [--namespace <namespace>]
18191820
<pool-spec>
18201821
1821-
Disable RBD mirroring by default within a pool.
1822+
Disable RBD mirroring in a pool or namespace.
18221823
18231824
Positional arguments
18241825
<pool-spec> pool specification
@@ -1833,7 +1834,7 @@
18331834
[--site-name <site-name>]
18341835
<pool-spec> <mode>
18351836

1836-
Enable RBD mirroring by default within a pool.
1837+
Enable RBD mirroring in a pool or namespace.
18371838

18381839
Positional arguments
18391840
<pool-spec> pool specification
@@ -1850,7 +1851,7 @@
18501851
[--format <format>] [--pretty-format] [--all]
18511852
<pool-spec>
18521853
1853-
Show information about the pool mirroring configuration.
1854+
Show mirroring configuration for a pool or namespace.
18541855
18551856
Positional arguments
18561857
<pool-spec> pool specification
@@ -1958,7 +1959,7 @@
19581959
[--namespace <namespace>]
19591960
<pool-spec>
19601961

1961-
Promote all non-primary images in the pool.
1962+
Promote all non-primary images in a pool or namespace.
19621963

19631964
Positional arguments
19641965
<pool-spec> pool specification
@@ -1974,7 +1975,7 @@
19741975
[--format <format>] [--pretty-format] [--verbose]
19751976
<pool-spec>
19761977
1977-
Show status for all mirrored images in the pool.
1978+
Show status for all mirrored images in a pool or namespace.
19781979
19791980
Positional arguments
19801981
<pool-spec> pool specification

‎src/tools/rbd/action/MirrorPool.cc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1744,27 +1744,27 @@ Shell::Action action_set(
17441744

17451745
Shell::Action action_disable(
17461746
{"mirror", "pool", "disable"}, {},
1747-
"Disable RBD mirroring by default within a pool.", "",
1747+
"Disable RBD mirroring in a pool or namespace.", "",
17481748
&get_disable_arguments, &execute_disable);
17491749
Shell::Action action_enable(
17501750
{"mirror", "pool", "enable"}, {},
1751-
"Enable RBD mirroring by default within a pool.", "",
1751+
"Enable RBD mirroring in a pool or namespace.", "",
17521752
&get_enable_arguments, &execute_enable);
17531753
Shell::Action action_info(
17541754
{"mirror", "pool", "info"}, {},
1755-
"Show information about the pool mirroring configuration.", {},
1755+
"Show mirroring configuration for a pool or namespace.", {},
17561756
&get_info_arguments, &execute_info);
17571757
Shell::Action action_status(
17581758
{"mirror", "pool", "status"}, {},
1759-
"Show status for all mirrored images in the pool.", {},
1759+
"Show status for all mirrored images in a pool or namespace.", {},
17601760
&get_status_arguments, &execute_status);
17611761
Shell::Action action_promote(
17621762
{"mirror", "pool", "promote"}, {},
1763-
"Promote all non-primary images in the pool.", {},
1763+
"Promote all non-primary images in a pool or namespace.", {},
17641764
&get_promote_arguments, &execute_promote);
17651765
Shell::Action action_demote(
17661766
{"mirror", "pool", "demote"}, {},
1767-
"Demote all primary images in the pool.", {},
1767+
"Demote all primary images in a pool or namespace.", {},
17681768
&get_demote_arguments, &execute_demote);
17691769

17701770
} // namespace mirror_pool

0 commit comments

Comments
 (0)