Re: [RFC PATCH 4/5] Recommend git-filter-repo instead of git-filter-branch in documentation

From: Elijah Newren <newren@gmail.com>
Date: Aug 27, 2019, 06:23 UTC
Message-ID: <CABPp-BEBVNERNBApmWTaR03qS2cHPwQ=yRe6aSesOFUsX-2qFA@mail.gmail.com>
In-Reply-To: <e7df2ce3-f772-54b5-4e81-70510a897352@gmail.com>

On Mon, Aug 26, 2019 at 6:33 PM Derrick Stolee <stolee@gmail.com> wrote:

>
> On 8/26/2019 7:52 PM, Elijah Newren wrote:

Show 14 quoted lines

> > +WARNING
> > +-------
> > +'git filter-branch' has a litany of gotchas that can and will cause
> > +history to be rewritten incorrectly (in addition to abysmal
> > +performance).  These issues cannot be backward compatibly fixed and as
> > +such, its use is not recommended.  Please use an alternative history
> > +filtering tool such as 'git filter-repo'.  If you still need to use
> > +'git filter-branch', please carefully read the "Safety" section of
> > +https://public-inbox.org/git/CABPp-BEDOH-row-hxY4u_cP30ptqOpcCvPibwyZ2wBu142qUbA@mail.gmail.com/
>
> Is it possible to present this URL as a hyperlink with a succinct
> description? Maybe 'carefully read [the "Safety" section of this
> message on the Git mailing list](url).' (I'm using Markdown notation
> here as I don't know the equivalent for our docs.)

Looks like the syntax is
  URL[description]
e.g.
  https://public-inbox.org/git/CABPp-BEDOH-etc-etc-etc@mail.gmail.com[the
"Safety" section of yadda yadda]

I'll fix that up.