Re: [PATCH 0/5] Remove now-unused git-parse-remote

From: Jeff King <peff@peff.net>
Date: Nov 11, 2020, 17:37 UTC
Message-ID: <20201111173738.GB9902@coredump.intra.peff.net>
In-Reply-To: <20201111151754.31527-1-avarab@gmail.com>

On Wed, Nov 11, 2020 at 04:17:49PM +0100, Ævar Arnfjörð Bjarmason wrote:

Show 8 quoted lines

> I started poking at removing .git/branches from the default template,
> which I had a patch for until I noticed Johannes's old[1] series.
> 
> In any case, this is one thing that came out of that
> investigation. The code we're keeping by moving it to git-submodule.sh
> can also be replaced by some C code we have, but I wanted to leave
> that to another submission (if I'll get to it), and make this simply a
> code removal.

I'm happy to see unused code go away in general, but this raises a question: what promises have we made to end-user scripts about this library being available?

We do install it, including a manpage which claims you can do:

  . "$(git --exec-path)/git-parse-remote"

though it does not actually document any particular functions being available. It looks like we've removed functions before without warning (e.g., 1a92777504 (git-request-pull: open-code the only invocation of get_remote_url, 2011-03-01)).

I'm just wondering if we need to have any kind of warning or deprecation period.

To be clear, I find it pretty unlikely that anybody is using the rather esoteric functions in this file, but that's usually when I get most surprised. :)

Show 8 quoted lines

>  .gitignore                         |  1 -
>  Documentation/git-parse-remote.txt | 23 -------
>  Makefile                           |  2 -
>  command-list.txt                   |  1 -
>  git-parse-remote.sh                | 98 ------------------------------
>  git-submodule.sh                   |  8 ++-
>  6 files changed, 7 insertions(+), 126 deletions(-)
>  delete mode 100644 Documentation/git-parse-remote.txt

I expected to see a "delete" line for git-parse-remote.sh here. I thought at first maybe you were leaving the empty shell so that people could continue to source it (keeping the promise in the manpage, but not providing any actual functions). But it looks like the final patch stops building it at all, leaving the now-useless source file.

-Peff