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 <newren@gmail.com>
pull/299/head
Elijah Newren 3 years ago
parent 05e3548b67
commit 933475ecf1

@ -93,6 +93,10 @@ Analysis Options
Filtering based on paths (see also --filename-callback)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These options specify the paths to select. Note that much like git
itself, renames are NOT followed so you may need to specify multiple
paths, e.g. `--path olddir/ --path newdir/`
--invert-paths::
Invert the selection of files from the specified
--path-{match,glob,regex} options below, i.e. only select

@ -1766,7 +1766,13 @@ EXAMPLES
"refuses to run if exists, --force delete existing dir first."))
path = parser.add_argument_group(title=_("Filtering based on paths "
"(see also --filename-callback)"))
"(see also --filename-callback)"),
description=textwrap.dedent(_("""
These options specify the paths to select. Note that much like git
itself, renames are NOT followed so you may need to specify multiple
paths, e.g. `--path olddir/ --path newdir/`
"""[1:])))
path.add_argument('--invert-paths', action='store_false', dest='inclusive',
help=_("Invert the selection of files from the specified "
"--path-{match,glob,regex} options below, i.e. only select "

Loading…
Cancel
Save