Skip to content

Commit 933475e

Browse files
committed
Make it clearer that --path* do not follow renames
The wording "exact paths" appears to not be clear enough for folks and I keep repeatedly getting bug reports about filter-repo not following renames. Make it very explicit. Signed-off-by: Elijah Newren <[email protected]>
1 parent 05e3548 commit 933475e

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

Documentation/git-filter-repo.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ Analysis Options
9393
Filtering based on paths (see also --filename-callback)
9494
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9595

96+
These options specify the paths to select. Note that much like git
97+
itself, renames are NOT followed so you may need to specify multiple
98+
paths, e.g. `--path olddir/ --path newdir/`
99+
96100
--invert-paths::
97101
Invert the selection of files from the specified
98102
--path-{match,glob,regex} options below, i.e. only select

git-filter-repo

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1766,7 +1766,13 @@ EXAMPLES
17661766
"refuses to run if exists, --force delete existing dir first."))
17671767

17681768
path = parser.add_argument_group(title=_("Filtering based on paths "
1769-
"(see also --filename-callback)"))
1769+
"(see also --filename-callback)"),
1770+
description=textwrap.dedent(_("""
1771+
These options specify the paths to select. Note that much like git
1772+
itself, renames are NOT followed so you may need to specify multiple
1773+
paths, e.g. `--path olddir/ --path newdir/`
1774+
"""[1:])))
1775+
17701776
path.add_argument('--invert-paths', action='store_false', dest='inclusive',
17711777
help=_("Invert the selection of files from the specified "
17721778
"--path-{match,glob,regex} options below, i.e. only select "

0 commit comments

Comments
 (0)