Re: [PATCH] Add shell completion for git remote rm

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 16, 2018, 18:57 UTC
Message-ID: <xmqqh8rlvdgh.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <CACsJy8Dzv3qPc1dB1rdvYL+CvEp+hY8ddoBrbCiP5KnqikzyLw@mail.gmail.com>

Duy Nguyen <pclouds@gmail.com> writes:

Show 7 quoted lines

> On Tue, Jan 16, 2018 at 4:43 AM, Keith Smiley <k@keith.so> wrote:
>> So it sounds like either we should deprecate rm, or I should update the patch to the suggested method where we just complete remotes, but not rm in the list of completions.
>
> I vote for deprecation. I could send a patch to start warning to
> switch from 'rm' to 'remove'. Then perhaps we can delete it after two
> releases. It's not classified as plumbing should we don't have worry
> too much about scripts relying on 'remote rm'.

I do not know about "two releases" part (which amounts to merely 20-24 weeks), but looking at "git remote -h" output and seeing that we do spell out "rename" (instead of saying "mv" or something cryptic), it probably makes sense to remove "rm" some time in the future.

I actually do think "rm" is _already_ deprecated.

"git remote --help" does not mention it in its synopsis section and it merely has ", rm" after "remove" as if an afterthought. I am not sure if it is worth being more explicit, perhaps like this?

 Documentation/git-remote.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 577b969c1b..149db90346 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -93,7 +93,8 @@ the configuration file format.
 'rm'::
 
 Remove the remote named <name>. All remote-tracking branches and
-configuration settings for the remote are removed.
+configuration settings for the remote are removed.  `rm` is a deprecated
+synonym that will be removed in future versions of Git.
 
 'set-head'::