Marown/git-filter-repo
1
0
Fork 0
mirror of https://github.com/newren/git-filter-repo.git synced 2024-07-04 01:15:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

git-filter-repo.txt: be more forceful on the wording of --force

Browse Source 
Online blogs/articles/Q&A as well as direct feedback suggests that
people use the --force flag rather cavalierly.  Add words like
"irreversible" and "immediate pruning" to discourage such blithe
application of this flag.  I hope this encourages folks to either learn
the ramifications of irreversible full-repository entire history
rewrites first, or to follow the recommendation of only operating on a
fresh clone.

Signed-off-by: Elijah Newren <newren@gmail.com>
This commit is contained in:
Elijah Newren 2020-06-20 23:26:50 -07:00
parent f8c14d159c
commit 8abf8faec8
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/git-filter-repo.txt
View File

@ -296,10 +296,12 @@ Miscellaneous options
--force:: --force::
-f:: -f::
Rewrite history even if the current repo does not look like a Ignore fresh clone checks and rewrite history (an irreversible
fresh clone. See <<FRESHCLONE>>. Note that when cloning operation, especially since it by default ends with an
repos on a local filesystem, it is better to pass `--no-local` immediate pruning of reflogs and old objects). See
to git clone than passing `--force` to git-filter-repo. <<FRESHCLONE>>. 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:: --partial::
Do a partial history rewrite, resulting in the mixture of old and Do a partial history rewrite, resulting in the mixture of old and

6
git-filter-repo
View File

@ -1956,8 +1956,10 @@ EXAMPLES
misc.add_argument('--version', action='store_true', misc.add_argument('--version', action='store_true',
help=_("Display filter-repo's version and exit.")) help=_("Display filter-repo's version and exit."))
misc.add_argument('--force', '-f', action='store_true', misc.add_argument('--force', '-f', action='store_true',
help=_("Rewrite history even if the current repo does not look " help=_("Rewrite repository history even if the current repo does not "
"like a fresh clone.")) "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', misc.add_argument('--partial', action='store_true',
help=_("Do a partial history rewrite, resulting in the mixture of " help=_("Do a partial history rewrite, resulting in the mixture of "
"old and new history. This implies a default of " "old and new history. This implies a default of "