Skip to content

Commit bc8f191

Browse files
committed
examples-from-user-filed-issues.md: clarify multiple corruption handling
Some users may be tempted to only replace one out of several corrupt objects and then try to see how filter-repo handles it. The problem is that having any corrupt object is likely to cause one of fast-export, filter-repo, or fast-import to fail. Make it clear that all corrupt objects need to be replaced before running filter-repo. (There are some types of corruption that none of the systems will fail on, and which you can thus replace one at a time, but we don't want users relying on that and then coming back to us and asking why it doesn't work.) Signed-off-by: Elijah Newren <[email protected]>
1 parent 2d39146 commit bc8f191

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Documentation/examples-from-user-filed-issues.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -300,9 +300,10 @@ $ rm tmp
300300
$ git filter-repo --proceed
301301
```
302302

303-
Note that if you have multiple corrupt objects, you only need to run
304-
filter-repo once; that is, so long as you create all the replacements
305-
before you run filter-repo.
303+
Note that if you have multiple corrupt objects, you need to create
304+
replacements for all of them, and then run filter-repo. Leaving any
305+
corrupt object without a replacement is likely to cause the filter-repo run
306+
to fail.
306307

307308
### Handling repository corruption -- tree objects
308309

0 commit comments

Comments
 (0)