diff --git a/Documentation/git-filter-repo.txt b/Documentation/git-filter-repo.txt index 4a1d574..4d533ac 100644 --- a/Documentation/git-filter-repo.txt +++ b/Documentation/git-filter-repo.txt @@ -296,10 +296,12 @@ Miscellaneous options --force:: -f:: - Rewrite history even if the current repo does not look like a - fresh clone. See <>. Note that when cloning - repos on a local filesystem, it is better to pass `--no-local` - to git clone than passing `--force` to git-filter-repo. + Ignore fresh clone checks and rewrite history (an irreversible + operation, especially since it by default ends with an + immediate pruning of reflogs and old objects). See + <>. Note that when cloning repos on a local + filesystem, it is better to pass `--no-local` to git clone + than passing `--force` to git-filter-repo. --partial:: Do a partial history rewrite, resulting in the mixture of old and diff --git a/git-filter-repo b/git-filter-repo index d1580c5..9eae62f 100755 --- a/git-filter-repo +++ b/git-filter-repo @@ -1956,8 +1956,10 @@ EXAMPLES misc.add_argument('--version', action='store_true', help=_("Display filter-repo's version and exit.")) misc.add_argument('--force', '-f', action='store_true', - help=_("Rewrite history even if the current repo does not look " - "like a fresh clone.")) + help=_("Rewrite repository history even if the current repo does not " + "look like a fresh clone. History rewriting is irreversible " + "(and includes immediate pruning of reflogs and old objects), " + "so be cautious about using this flag.")) misc.add_argument('--partial', action='store_true', help=_("Do a partial history rewrite, resulting in the mixture of " "old and new history. This implies a default of "