[PATCH] Minor clarifications to git-filter-branch usage and doc
From: Brian Gernhardt <hidden>
Date: 2016-06-15 22:43:29
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
- Remove "DESTBRANCH" from usage, as it rewrites the branches given - Remove an = from an example usage that the script doesn't understand Signed-off-by: Brian Gernhardt <redacted> --- It took me way too long to figure out how to just delete a single file from the history. From the docs and usage it looked I needed $ git filter-branch --index-filter \ "git update-index --force-remove file" \ --tag-name-filter=cat newbranch HEAD I eventually determined the following $ git filter-branch --index-filter \ "git update-index --force-remove file" \ --tag-name-filter cat master The following changes changes the parts that led me astray, although I think it still could be clearer even if I don't know how to write it. Documentation/git-filter-branch.txt | 2 +- git-filter-branch.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 915258f..8c43be6 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt@@ -120,7 +120,7 @@ have all of them as parents. tag name is expected on standard output. + The original tags are not deleted, but can be overwritten; -use "--tag-name-filter=cat" to simply update the tags. In this +use "--tag-name-filter cat" to simply update the tags. In this case, be very careful and make sure you have the old tags backed up in case the conversion has run afoul. +
diff --git a/git-filter-branch.sh b/git-filter-branch.sh
index c42e451..9f10c30 100755
--- a/git-filter-branch.sh
+++ b/git-filter-branch.sh@@ -8,7 +8,7 @@ # a new branch. You can specify a number of filters to modify the commits, # files and trees. -USAGE="git-filter-branch [-d TEMPDIR] [FILTERS] DESTBRANCH [REV-RANGE]" +USAGE="git-filter-branch [-d TEMPDIR] [FILTERS] [BRANCHES]" . git-sh-setup warn () {
--
1.5.3.rc5.11.g312e