Re: [PATCH] docs: add filter-branch note about The BFG
flat view
From: Jonathan Nieder <hidden>
Date: 2016-06-15 22:59:28
Hi, Roberto Tyley wrote:
The BFG is a tool specifically designed for the task of removing unwanted data from Git repository history - a common use-case for which git-filter-branch has been the traditional workhorse. It's beneficial to let users know that filter-branch has an alternative here:
That sounds like a good suggestion for the SEE ALSO section, or an explanation of when each tool should be used would be a good thing to put in NOTES, but... [...]
quoted hunk ↗ jump to hunk
--- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt@@ -18,6 +18,12 @@ SYNOPSIS DESCRIPTION ----------- + +NOTE: For simply removing unwanted data from repository history, you may +want to use link:http://rtyley.github.io/bfg-repo-cleaner/[The BFG Repo-Cleaner] +instead - it's generally faster and simpler for eliminating large files +or private data.
... this shouting NOTE at the top of the description is way over the top. So as is, this patch looks like a net negative. Thanks and hope that helps, Jonathan