tool: Replace Kudu replica with tablet replica in help text The help text is clearer when we use the term "tablet replica" instead of "Kudu replica" or just standalone "replica", especially for new users.
This does not change the names of the modes or actions. Change-Id: Iec236fb145cd4b9c7a5027898f9beb9262f5893a Reviewed-on: http://gerrit.cloudera.org:8080/5310 Tested-by: Kudu Jenkins Reviewed-by: Adar Dembo <a...@cloudera.com> Project: http://git-wip-us.apache.org/repos/asf/kudu/repo Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/648d69e7 Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/648d69e7 Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/648d69e7 Branch: refs/heads/master Commit: 648d69e7e16a54b7ab38c3242732a7fd03e07e74 Parents: b28c6dd Author: Mike Percy <mpe...@apache.org> Authored: Thu Dec 1 19:54:08 2016 +0000 Committer: Adar Dembo <a...@cloudera.com> Committed: Thu Dec 1 23:50:26 2016 +0000 ---------------------------------------------------------------------- src/kudu/tools/kudu-tool-test.cc | 31 +++++++++++------------ src/kudu/tools/tool_action_local_replica.cc | 14 +++++----- src/kudu/tools/tool_action_remote_replica.cc | 12 ++++----- 3 files changed, 28 insertions(+), 29 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kudu/blob/648d69e7/src/kudu/tools/kudu-tool-test.cc ---------------------------------------------------------------------- diff --git a/src/kudu/tools/kudu-tool-test.cc b/src/kudu/tools/kudu-tool-test.cc index 176b5a2..5aa34ee 100644 --- a/src/kudu/tools/kudu-tool-test.cc +++ b/src/kudu/tools/kudu-tool-test.cc @@ -258,10 +258,10 @@ TEST_F(ToolTest, TestTopLevelHelp) { const vector<string> kTopLevelRegexes = { "cluster.*Kudu cluster", "fs.*Kudu filesystem", - "local_replica.*Kudu replicas", + "local_replica.*tablet replicas", "master.*Kudu Master", "pbc.*protobuf container", - "remote_replica.*replicas on a Kudu Tablet Server", + "remote_replica.*tablet replicas on a Kudu Tablet Server", "table.*Kudu tables", "tablet.*Kudu tablets", "test.*tests", @@ -295,11 +295,11 @@ TEST_F(ToolTest, TestModeHelp) { } { const vector<string> kLocalReplicaModeRegexes = { - "cmeta.*Operate on a local Kudu replica's consensus", + "cmeta.*Operate on a local tablet replica's consensus", "dump.*Dump a Kudu filesystem", - "copy_from_remote.*Copy a replica", - "delete.*Delete Kudu replica from the local filesystem", - "list.*Show list of Kudu replicas" + "copy_from_remote.*Copy a tablet replica", + "delete.*Delete tablet replica from the local filesystem", + "list.*Show list of tablet replicas" }; NO_FATALS(RunTestHelp("local_replica", kLocalReplicaModeRegexes)); } @@ -311,14 +311,13 @@ TEST_F(ToolTest, TestModeHelp) { "wals.*Dump all WAL" }; NO_FATALS(RunTestHelp("local_replica dump", kLocalReplicaDumpModeRegexes)); - } { - const vector<string> kCmetaModeRegexes = { - "print_replica_uuids.*Print all replica UUIDs", - "rewrite_raft_config.*Rewrite a replica" + const vector<string> kLocalReplicaCMetaRegexes = { + "print_replica_uuids.*Print all tablet replica peer UUIDs", + "rewrite_raft_config.*Rewrite a tablet replica" }; - NO_FATALS(RunTestHelp("local_replica cmeta", kCmetaModeRegexes)); + NO_FATALS(RunTestHelp("local_replica cmeta", kLocalReplicaCMetaRegexes)); } { const vector<string> kClusterModeRegexes = { @@ -342,11 +341,11 @@ TEST_F(ToolTest, TestModeHelp) { } { const vector<string> kRemoteReplicaModeRegexes = { - "check.*Check if all replicas", - "copy.*Copy a replica from one Kudu Tablet Server to another", - "delete.*Delete a replica", - "dump.*Dump the data of a replica", - "list.*List all replicas" + "check.*Check if all tablet replicas", + "copy.*Copy a tablet replica from one Kudu Tablet Server to another", + "delete.*Delete a tablet replica", + "dump.*Dump the data of a tablet replica", + "list.*List all tablet replicas" }; NO_FATALS(RunTestHelp("remote_replica", kRemoteReplicaModeRegexes)); } http://git-wip-us.apache.org/repos/asf/kudu/blob/648d69e7/src/kudu/tools/tool_action_local_replica.cc ---------------------------------------------------------------------- diff --git a/src/kudu/tools/tool_action_local_replica.cc b/src/kudu/tools/tool_action_local_replica.cc index 21f0e23..47e60aa 100644 --- a/src/kudu/tools/tool_action_local_replica.cc +++ b/src/kudu/tools/tool_action_local_replica.cc @@ -696,7 +696,7 @@ unique_ptr<Mode> BuildDumpMode() { unique_ptr<Mode> BuildLocalReplicaMode() { unique_ptr<Action> print_replica_uuids = ActionBuilder("print_replica_uuids", &PrintReplicaUuids) - .Description("Print all replica UUIDs found in a " + .Description("Print all tablet replica peer UUIDs found in a " "tablet's Raft configuration") .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .AddOptionalParameter("fs_wal_dir") @@ -705,7 +705,7 @@ unique_ptr<Mode> BuildLocalReplicaMode() { unique_ptr<Action> rewrite_raft_config = ActionBuilder("rewrite_raft_config", &RewriteRaftConfig) - .Description("Rewrite a replica's Raft configuration") + .Description("Rewrite a tablet replica's Raft configuration") .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .AddRequiredVariadicParameter({ "peers", "List of peers where each peer is of " @@ -716,7 +716,7 @@ unique_ptr<Mode> BuildLocalReplicaMode() { unique_ptr<Mode> cmeta = ModeBuilder("cmeta") - .Description("Operate on a local Kudu replica's consensus " + .Description("Operate on a local tablet replica's consensus " "metadata file") .AddAction(std::move(print_replica_uuids)) .AddAction(std::move(rewrite_raft_config)) @@ -724,7 +724,7 @@ unique_ptr<Mode> BuildLocalReplicaMode() { unique_ptr<Action> copy_from_remote = ActionBuilder("copy_from_remote", &CopyFromRemote) - .Description("Copy a replica from a remote server") + .Description("Copy a tablet replica from a remote server") .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .AddRequiredParameter({ "source", "Source RPC address of " "form hostname:port" }) @@ -734,7 +734,7 @@ unique_ptr<Mode> BuildLocalReplicaMode() { unique_ptr<Action> list = ActionBuilder("list", &ListLocalReplicas) - .Description("Show list of Kudu replicas in the local filesystem") + .Description("Show list of tablet replicas in the local filesystem") .AddOptionalParameter("fs_wal_dir") .AddOptionalParameter("fs_data_dirs") .AddOptionalParameter("list_detail") @@ -742,7 +742,7 @@ unique_ptr<Mode> BuildLocalReplicaMode() { unique_ptr<Action> delete_local_replica = ActionBuilder("delete", &DeleteLocalReplica) - .Description("Delete Kudu replica from the local filesystem") + .Description("Delete tablet replica from the local filesystem") .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .AddOptionalParameter("fs_wal_dir") .AddOptionalParameter("fs_data_dirs") @@ -750,7 +750,7 @@ unique_ptr<Mode> BuildLocalReplicaMode() { .Build(); return ModeBuilder("local_replica") - .Description("Operate on local Kudu replicas via the local filesystem") + .Description("Operate on local tablet replicas via the local filesystem") .AddMode(std::move(cmeta)) .AddAction(std::move(copy_from_remote)) .AddAction(std::move(delete_local_replica)) http://git-wip-us.apache.org/repos/asf/kudu/blob/648d69e7/src/kudu/tools/tool_action_remote_replica.cc ---------------------------------------------------------------------- diff --git a/src/kudu/tools/tool_action_remote_replica.cc b/src/kudu/tools/tool_action_remote_replica.cc index 625afb0..ec8c6ea 100644 --- a/src/kudu/tools/tool_action_remote_replica.cc +++ b/src/kudu/tools/tool_action_remote_replica.cc @@ -339,13 +339,13 @@ Status CopyReplica(const RunnerContext& context) { unique_ptr<Mode> BuildRemoteReplicaMode() { unique_ptr<Action> check_replicas = ActionBuilder("check", &CheckReplicas) - .Description("Check if all replicas on a Kudu Tablet Server are running") + .Description("Check if all tablet replicas on a Kudu Tablet Server are running") .AddRequiredParameter({ kTServerAddressArg, kTServerAddressDesc }) .Build(); unique_ptr<Action> copy_replica = ActionBuilder("copy", &CopyReplica) - .Description("Copy a replica from one Kudu Tablet Server to another") + .Description("Copy a tablet replica from one Kudu Tablet Server to another") .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .AddRequiredParameter({ kSrcAddressArg, kTServerAddressDesc }) .AddRequiredParameter({ kDstAddressArg, kTServerAddressDesc }) @@ -353,7 +353,7 @@ unique_ptr<Mode> BuildRemoteReplicaMode() { unique_ptr<Action> delete_replica = ActionBuilder("delete", &DeleteReplica) - .Description("Delete a replica from a Kudu Tablet Server") + .Description("Delete a tablet replica from a Kudu Tablet Server") .AddRequiredParameter({ kTServerAddressArg, kTServerAddressDesc }) .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .AddRequiredParameter({ kReasonArg, "Reason for deleting the replica" }) @@ -361,19 +361,19 @@ unique_ptr<Mode> BuildRemoteReplicaMode() { unique_ptr<Action> dump_replica = ActionBuilder("dump", &DumpReplica) - .Description("Dump the data of a replica on a Kudu Tablet Server") + .Description("Dump the data of a tablet replica on a Kudu Tablet Server") .AddRequiredParameter({ kTServerAddressArg, kTServerAddressDesc }) .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc }) .Build(); unique_ptr<Action> list = ActionBuilder("list", &ListReplicas) - .Description("List all replicas on a Kudu Tablet Server") + .Description("List all tablet replicas on a Kudu Tablet Server") .AddRequiredParameter({ kTServerAddressArg, kTServerAddressDesc }) .Build(); return ModeBuilder("remote_replica") - .Description("Operate on replicas on a Kudu Tablet Server") + .Description("Operate on remote tablet replicas on a Kudu Tablet Server") .AddAction(std::move(check_replicas)) .AddAction(std::move(copy_replica)) .AddAction(std::move(delete_replica))
