From f6527759d812bd7b873d36083ac029b327ca978c Mon Sep 17 00:00:00 2001 From: Aditya Maru Date: Tue, 8 Sep 2020 13:39:01 -0400 Subject: [PATCH] cli: add deprecation notice to dump CLI command Fixes: #54040 Release justification: low risk, high benefit changes to existing functionality --- pkg/cli/cli_test.go | 1 - pkg/cli/dump.go | 2 ++ pkg/cli/node.go | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/pkg/cli/cli_test.go b/pkg/cli/cli_test.go index ae8b10618dad..c672b17c0340 100644 --- 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 index 4a45e65de0ba..c91afe4756cc 100644 --- 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 index 264bf5dec5cf..8ed8f735362b 100644 --- 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, }