Marown/git-filter-repo
1
0
Fork 0
mirror of https://github.com/newren/git-filter-repo.git synced 2024-07-06 18:32:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

filter-repo (README): link to upstream docs

Browse Source 
Signed-off-by: Elijah Newren <newren@gmail.com>
This commit is contained in:
Elijah Newren 2020-02-01 09:48:21 -08:00
parent 96e217355c
commit bcd9964537
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -6,7 +6,9 @@ filter-branch](https://git-scm.com/docs/git-filter-branch) but without the
capitulation-inducing poor capitulation-inducing poor
[performance](https://public-inbox.org/git/CABPp-BGOz8nks0+Tdw5GyGqxeYR-3FF6FT5JcgVqZDYVRQ6qog@mail.gmail.com/), [performance](https://public-inbox.org/git/CABPp-BGOz8nks0+Tdw5GyGqxeYR-3FF6FT5JcgVqZDYVRQ6qog@mail.gmail.com/),
with far more capabilities, and with a design that scales usability-wise with far more capabilities, and with a design that scales usability-wise
beyond trivial rewriting cases. beyond trivial rewriting cases. [git filter-repo is now recommended by the
git project](https://git-scm.com/docs/git-filter-branch#_warning) instead
of git filter-branch.
While most users will probably just use filter-repo as a simple command While most users will probably just use filter-repo as a simple command
line tool (and likely only use a few of its flags), at its core filter-repo line tool (and likely only use a few of its flags), at its core filter-repo
@ -72,20 +74,25 @@ but some highlights for the main competitors:
* filter-branch is [extremely to unusably * filter-branch is [extremely to unusably
slow](https://public-inbox.org/git/CABPp-BGOz8nks0+Tdw5GyGqxeYR-3FF6FT5JcgVqZDYVRQ6qog@mail.gmail.com/) slow](https://public-inbox.org/git/CABPp-BGOz8nks0+Tdw5GyGqxeYR-3FF6FT5JcgVqZDYVRQ6qog@mail.gmail.com/)
([multiple orders of magnitude slower than it should ([multiple orders of magnitude slower than it should
be](https://htmlpreview.github.io/?https://raw.githubusercontent.com/newren/git-filter-repo/docs/html/git-filter-branch.html#PERFORMANCE)) be](https://git-scm.com/docs/git-filter-branch#PERFORMANCE))
for non-trivial repositories. for non-trivial repositories.
* [filter-branch is riddled with * [filter-branch is riddled with
gotchas](https://htmlpreview.github.io/?https://raw.githubusercontent.com/newren/git-filter-repo/docs/html/git-filter-branch.html#SAFETY) gotchas](https://git-scm.com/docs/git-filter-branch#SAFETY) that can
that can silently corrupt your rewrite or at least thwart your silently corrupt your rewrite or at least thwart your "cleanup"
"cleanup" efforts by giving you something more problematic and messy efforts by giving you something more problematic and messy than what
than what you started with. you started with.
* filter-branch is [very onerous](#simple-example-with-comparisons) * filter-branch is [very onerous](#simple-example-with-comparisons)
[to [to
use](https://github.com/newren/git-filter-repo/blob/a6a6a1b0f62d365bbe2e76f823e1621857ec4dbd/contrib/filter-repo-demos/filter-lamely#L9-L61) use](https://github.com/newren/git-filter-repo/blob/a6a6a1b0f62d365bbe2e76f823e1621857ec4dbd/contrib/filter-repo-demos/filter-lamely#L9-L61)
for any rewrite which is even slightly non-trivial. for any rewrite which is even slightly non-trivial.
* the git project has stated that the above issues with filter-branch
cannot be backward compatibly fixed; they recommend that you [stop
using
filter-branch](https://git-scm.com/docs/git-filter-branch#_warning)
* die-hard fans of filter-branch may be interested in * die-hard fans of filter-branch may be interested in
[filter-lamely](contrib/filter-repo-demos/filter-lamely) [filter-lamely](contrib/filter-repo-demos/filter-lamely)
(a.k.a. [filter-branch-ish](contrib/filter-repo-demos/filter-branch-ish)), (a.k.a. [filter-branch-ish](contrib/filter-repo-demos/filter-branch-ish)),