git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Taylor Blau <me@ttaylorr.com>
To: Elijah Newren via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	Elijah Newren <newren@gmail.com>
Subject: Re: [PATCH 2/2] RelNotes/2.24.0: fix self-contradictory note
Date: Fri, 1 Nov 2019 20:32:36 -0700	[thread overview]
Message-ID: <20191102033236.GB93209@syl.local> (raw)
In-Reply-To: <0f3aa67e4aafbb7befd37d83a8c0d53a0a186259.1572466878.git.gitgitgadget@gmail.com>

On Wed, Oct 30, 2019 at 08:21:18PM +0000, Elijah Newren via GitGitGadget wrote:
> From: Elijah Newren <newren@gmail.com>
>
> As per Wikipedia, "In current technical usage, for one to state that a
> feature is deprecated is merely a recommendation against using it."  It
> is thus contradictory to claim that something is not "officially
> deprecated" and then to immediately state that we are both discouraging
> its use and pointing people elsewhere.
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
>  Documentation/RelNotes/2.24.0.txt | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.txt
> index 26e018078d..bde154124c 100644
> --- a/Documentation/RelNotes/2.24.0.txt
> +++ b/Documentation/RelNotes/2.24.0.txt
> @@ -6,10 +6,9 @@ Updates since v2.23
>
>  Backward compatibility note
>
> - * Although it is not officially deprecated, "filter-branch" is
> -   showing its age and alternatives are available.  From this release,
> -   we started to discourage its uses and hint people about
> -   filter-repo.
> + * "filter-branch" is showing its age and alternatives are available.
> +   From this release, we started to discourage its use and hint
> +   people about filter-repo.

I suspect that this change was motivated by our off-list correspondence,
where I struggled to phrase a section about this in GitHub's release
highlights.

I think that I'm mostly reflecting what Elijah has already said himself
in another thread, but this change makes sense to me. I think that we
have effectively deprecated 'git-filter-branch'. If we're printing
warnings when it is called, and recommended that users refer to
'git-filter-repo' instead, I think that we might as well call it
deprecated.

But, if that phrase is too heavy-handed for 2.24, I think that this
patch makes a lot of sense. It's--as Elijah notes--confusing to say that
we recommend against using a tool but haven't 'officially' deprecated
it. This works nicely around that issue by not using the phrase
'deprecated' at all, and instead being clear about what the state of
'git filter-branch' is.

>  UI, Workflows & Features
>
> --
> gitgitgadget

Looks good to me.

Thanks,
Taylor

  reply	other threads:[~2019-11-02  3:32 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-30 20:21 [PATCH 0/2] 2.24 release note fixups Elijah Newren via GitGitGadget
2019-10-30 20:21 ` [PATCH 1/2] RelNotes/2.24.0: typofix Elijah Newren via GitGitGadget
2019-11-02  3:28   ` Taylor Blau
2019-11-02  5:43   ` Junio C Hamano
2019-10-30 20:21 ` [PATCH 2/2] RelNotes/2.24.0: fix self-contradictory note Elijah Newren via GitGitGadget
2019-11-02  3:32   ` Taylor Blau [this message]
2019-11-02  6:18     ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191102033236.GB93209@syl.local \
    --to=me@ttaylorr.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    --cc=newren@gmail.com \
    --subject='Re: [PATCH 2/2] RelNotes/2.24.0: fix self-contradictory note' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).