Merge #54044

54044: cli: add deprecation notice to dump CLI command r=dt,knz a=adityamaru Fixes: #54040 Release justification: low risk, high benefit changes to existing functionality Co-authored-by: Aditya Maru <adityamaru@gmail.com>
cockroachdb · Sep 8, 2020 · 5e43478 · 5e43478
2 parents 6a162df + 127bae5
commit 5e43478
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/pkg/cli/cli_test.go b/pkg/cli/cli_test.go
@@ -1423,7 +1423,6 @@ Available Commands:
   statement-diag    commands for managing statement diagnostics bundles
   auth-session      log in and out of HTTP sessions
   node              list, inspect, drain or remove nodes
-  dump              dump sql tables
 
   nodelocal         upload and delete nodelocal files
   userfile          upload, list and delete user scoped files

diff --git a/pkg/cli/dump.go b/pkg/cli/dump.go
@@ -49,6 +49,8 @@ Dump SQL tables of a cockroach database. If the table name
 is omitted, dump all tables in the database.
 `,
 	RunE: MaybeDecorateGRPCError(runDump),
+	Deprecated: "cockroach dump will be removed in a subsequent release.\n" +
+		"For details, see: https://github.com/cockroachdb/cockroach/issues/54040",
 }
 
 // We accept versions that are strictly newer than v2.1.0-alpha.20180416

diff --git a/pkg/cli/node.go b/pkg/cli/node.go
@@ -625,7 +625,7 @@ var nodeCmds = []*cobra.Command{
 
 var nodeCmd = &cobra.Command{
 	Use:   "node [command]",
-	Short: "list, inspect, drain or remove nodes",
+	Short: "list, inspect, drain or remove nodes\n",
 	Long:  "List, inspect, drain or remove nodes.",
 	RunE:  usageAndErr,
 }