diff options
| author | Junio C Hamano <gitster@pobox.com> | 2019-12-25 13:12:55 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-12-25 13:12:55 -0800 |
| commit | 2f5a9896b8a0020ce124ca87764bc91f565e48bb (patch) | |
| tree | 169d2a3dbcd625aef74728e004d2d20157a5bcbd /git-filter-branch.html | |
| parent | 2267da58fbe3aef887c21a27fd6b056bf6b38fcf (diff) | |
| download | git-htmldocs-2f5a9896b8a0020ce124ca87764bc91f565e48bb.tar.gz | |
Autogenerated HTML docs for v2.25.0-rc0
Diffstat (limited to 'git-filter-branch.html')
| -rw-r--r-- | git-filter-branch.html | 249 |
1 files changed, 129 insertions, 120 deletions
diff --git a/git-filter-branch.html b/git-filter-branch.html index 155ef66bc..f892c5ad4 100644 --- a/git-filter-branch.html +++ b/git-filter-branch.html @@ -1279,16 +1279,16 @@ impossible for a backward-compatible implementation to ever be fast:</p></div> <li>
<p>
In editing files, git-filter-branch by design checks out each and
-every commit as it existed in the original repo. If your repo has 10^5
-files and 10^5 commits, but each commit only modifies 5 files, then
-git-filter-branch will make you do 10^10 modifications, despite only
-having (at most) 5*10^5 unique blobs.
+ every commit as it existed in the original repo. If your repo has
+ 10^5 files and 10^5 commits, but each commit only modifies 5
+ files, then git-filter-branch will make you do 10^10 modifications,
+ despite only having (at most) 5*10^5 unique blobs.
</p>
</li>
<li>
<p>
If you try and cheat and try to make git-filter-branch only work on
-files modified in a commit, then two things happen
+ files modified in a commit, then two things happen
</p>
<div class="ulist"><ul>
<li>
@@ -1303,10 +1303,10 @@ you run into problems with deletions whenever the user is simply <li>
<p>
even if you succeed at the map-deletes-for-renames chicanery, you
- still technically violate backward compatibility because users are
- allowed to filter files in ways that depend upon topology of
- commits instead of filtering solely based on file contents or names
- (though this has not been observed in the wild).
+ still technically violate backward compatibility because users
+ are allowed to filter files in ways that depend upon topology of
+ commits instead of filtering solely based on file contents or
+ names (though this has not been observed in the wild).
</p>
</li>
</ul></div>
@@ -1314,42 +1314,44 @@ even if you succeed at the map-deletes-for-renames chicanery, you <li>
<p>
Even if you don’t need to edit files but only want to e.g. rename or
-remove some and thus can avoid checking out each file (i.e. you can use
---index-filter), you still are passing shell snippets for your filters.
-This means that for every commit, you have to have a prepared git repo
-where those filters can be run. That’s a significant setup.
+ remove some and thus can avoid checking out each file (i.e. you can
+ use --index-filter), you still are passing shell snippets for your
+ filters. This means that for every commit, you have to have a
+ prepared git repo where those filters can be run. That’s a
+ significant setup.
</p>
</li>
<li>
<p>
-Further, several additional files are created or updated per commit by
-git-filter-branch. Some of these are for supporting the convenience
-functions provided by git-filter-branch (such as map()), while others
-are for keeping track of internal state (but could have also been
-accessed by user filters; one of git-filter-branch’s regression tests
-does so). This essentially amounts to using the filesystem as an IPC
-mechanism between git-filter-branch and the user-provided filters.
-Disks tend to be a slow IPC mechanism, and writing these files also
-effectively represents a forced synchronization point between separate
-processes that we hit with every commit.
+Further, several additional files are created or updated per commit
+ by git-filter-branch. Some of these are for supporting the
+ convenience functions provided by git-filter-branch (such as map()),
+ while others are for keeping track of internal state (but could have
+ also been accessed by user filters; one of git-filter-branch’s
+ regression tests does so). This essentially amounts to using the
+ filesystem as an IPC mechanism between git-filter-branch and the
+ user-provided filters. Disks tend to be a slow IPC mechanism, and
+ writing these files also effectively represents a forced
+ synchronization point between separate processes that we hit with
+ every commit.
</p>
</li>
<li>
<p>
The user-provided shell commands will likely involve a pipeline of
-commands, resulting in the creation of many processes per commit.
-Creating and running another process takes a widely varying amount of
-time between operating systems, but on any platform it is very slow
-relative to invoking a function.
+ commands, resulting in the creation of many processes per commit.
+ Creating and running another process takes a widely varying amount
+ of time between operating systems, but on any platform it is very
+ slow relative to invoking a function.
</p>
</li>
<li>
<p>
git-filter-branch itself is written in shell, which is kind of slow.
-This is the one performance issue that could be backward-compatibly
-fixed, but compared to the above problems that are intrinsic to the
-design of git-filter-branch, the language of the tool itself is a
-relatively minor issue.
+ This is the one performance issue that could be backward-compatibly
+ fixed, but compared to the above problems that are intrinsic to the
+ design of git-filter-branch, the language of the tool itself is a
+ relatively minor issue.
</p>
<div class="ulist"><ul>
<li>
@@ -1391,63 +1393,67 @@ with:</p></div> <li>
<p>
Someone can have a set of "working and tested filters" which they
-document or provide to a coworker, who then runs them on a different OS
-where the same commands are not working/tested (some examples in the
-git-filter-branch manpage are also affected by this). BSD vs. GNU
-userland differences can really bite. If lucky, error messages are
-spewed. But just as likely, the commands either don’t do the filtering
-requested, or silently corrupt by making some unwanted change. The
-unwanted change may only affect a few commits, so it’s not necessarily
-obvious either. (The fact that problems won’t necessarily be obvious
-means they are likely to go unnoticed until the rewritten history is in
-use for quite a while, at which point it’s really hard to justify
-another flag-day for another rewrite.)
+ document or provide to a coworker, who then runs them on a different
+ OS where the same commands are not working/tested (some examples in
+ the git-filter-branch manpage are also affected by this).
+ BSD vs. GNU userland differences can really bite. If lucky, error
+ messages are spewed. But just as likely, the commands either don’t
+ do the filtering requested, or silently corrupt by making some
+ unwanted change. The unwanted change may only affect a few commits,
+ so it’s not necessarily obvious either. (The fact that problems
+ won’t necessarily be obvious means they are likely to go unnoticed
+ until the rewritten history is in use for quite a while, at which
+ point it’s really hard to justify another flag-day for another
+ rewrite.)
</p>
</li>
<li>
<p>
Filenames with spaces are often mishandled by shell snippets since
-they cause problems for shell pipelines. Not everyone is familiar with
-find -print0, xargs -0, git-ls-files -z, etc. Even people who are
-familiar with these may assume such flags are not relevant because
-someone else renamed any such files in their repo back before the person
-doing the filtering joined the project. And often, even those familiar
-with handling arguments with spaces may not do so just because they
-aren’t in the mindset of thinking about everything that could possibly
-go wrong.
+ they cause problems for shell pipelines. Not everyone is familiar
+ with find -print0, xargs -0, git-ls-files -z, etc. Even people who
+ are familiar with these may assume such flags are not relevant
+ because someone else renamed any such files in their repo back
+ before the person doing the filtering joined the project. And
+ often, even those familiar with handling arguments with spaces may
+ not do so just because they aren’t in the mindset of thinking about
+ everything that could possibly go wrong.
</p>
</li>
<li>
<p>
-Non-ascii filenames can be silently removed despite being in a desired
-directory. Keeping only wanted paths is often done using pipelines like
-<code>git ls-files | grep -v ^WANTED_DIR/ | xargs git rm</code>. ls-files will
-only quote filenames if needed, so folks may not notice that one of the
-files didn’t match the regex (at least not until it’s much too late).
-Yes, someone who knows about core.quotePath can avoid this (unless they
-have other special characters like \t, \n, or "), and people who use
-ls-files -z with something other than grep can avoid this, but that
-doesn’t mean they will.
+Non-ascii filenames can be silently removed despite being in a
+ desired directory. Keeping only wanted paths is often done using
+ pipelines like <code>git ls-files | grep -v ^WANTED_DIR/ | xargs git rm</code>.
+ ls-files will only quote filenames if needed, so folks may not
+ notice that one of the files didn’t match the regex (at least not
+ until it’s much too late). Yes, someone who knows about
+ core.quotePath can avoid this (unless they have other special
+ characters like \t, \n, or "), and people who use ls-files -z with
+ something other than grep can avoid this, but that doesn’t mean they
+ will.
</p>
</li>
<li>
<p>
-Similarly, when moving files around, one can find that filenames with
-non-ascii or special characters end up in a different directory, one
-that includes a double quote character. (This is technically the same
-issue as above with quoting, but perhaps an interesting different way
-that it can and has manifested as a problem.)
+Similarly, when moving files around, one can find that filenames
+ with non-ascii or special characters end up in a different
+ directory, one that includes a double quote character. (This is
+ technically the same issue as above with quoting, but perhaps an
+ interesting different way that it can and has manifested as a
+ problem.)
</p>
</li>
<li>
<p>
It’s far too easy to accidentally mix up old and new history. It’s
-still possible with any tool, but git-filter-branch almost invites it.
-If lucky, the only downside is users getting frustrated that they don’t
-know how to shrink their repo and remove the old stuff. If unlucky,
-they merge old and new history and end up with multiple "copies" of each
-commit, some of which have unwanted or sensitive files and others which
-don’t. This comes about in multiple different ways:
+ still possible with any tool, but git-filter-branch almost
+ invites it. If lucky, the only downside is users getting frustrated
+ that they don’t know how to shrink their repo and remove the old
+ stuff. If unlucky, they merge old and new history and end up with
+ multiple "copies" of each commit, some of which have unwanted or
+ sensitive files and others which don’t. This comes about in
+ multiple different ways:
</p>
<div class="ulist"><ul>
<li>
@@ -1483,8 +1489,8 @@ the fact that little educational information is provided to inform </li>
<li>
<p>
-Annotated tags can be accidentally converted to lightweight tags, due
-to either of two issues:
+Annotated tags can be accidentally converted to lightweight tags,
+ due to either of two issues:
</p>
<div class="ulist"><ul>
<li>
@@ -1508,65 +1514,67 @@ Running git-filter-branch with either --tags or --all in your <li>
<p>
Any commit messages that specify an encoding will become corrupted
-by the rewrite; git-filter-branch ignores the encoding, takes the original
-bytes, and feeds it to commit-tree without telling it the proper
-encoding. (This happens whether or not --msg-filter is used.)
+ by the rewrite; git-filter-branch ignores the encoding, takes the
+ original bytes, and feeds it to commit-tree without telling it the
+ proper encoding. (This happens whether or not --msg-filter is
+ used.)
</p>
</li>
<li>
<p>
Commit messages (even if they are all UTF-8) by default become
-corrupted due to not being updated — any references to other commit
-hashes in commit messages will now refer to no-longer-extant commits.
+ corrupted due to not being updated — any references to other commit
+ hashes in commit messages will now refer to no-longer-extant
+ commits.
</p>
</li>
<li>
<p>
-There are no facilities for helping users find what unwanted crud they
-should delete, which means they are much more likely to have incomplete
-or partial cleanups that sometimes result in confusion and people
-wasting time trying to understand. (For example, folks tend to just
-look for big files to delete instead of big directories or extensions,
-and once they do so, then sometime later folks using the new repository
-who are going through history will notice a build artifact directory
-that has some files but not others, or a cache of dependencies
-(node_modules or similar) which couldn’t have ever been functional since
-it’s missing some files.)
+There are no facilities for helping users find what unwanted crud
+ they should delete, which means they are much more likely to have
+ incomplete or partial cleanups that sometimes result in confusion
+ and people wasting time trying to understand. (For example, folks
+ tend to just look for big files to delete instead of big directories
+ or extensions, and once they do so, then sometime later folks using
+ the new repository who are going through history will notice a build
+ artifact directory that has some files but not others, or a cache of
+ dependencies (node_modules or similar) which couldn’t have ever been
+ functional since it’s missing some files.)
</p>
</li>
<li>
<p>
If --prune-empty isn’t specified, then the filtering process can
-create hoards of confusing empty commits
+ create hoards of confusing empty commits
</p>
</li>
<li>
<p>
If --prune-empty is specified, then intentionally placed empty
-commits from before the filtering operation are also pruned instead of
-just pruning commits that became empty due to filtering rules.
+ commits from before the filtering operation are also pruned instead
+ of just pruning commits that became empty due to filtering rules.
</p>
</li>
<li>
<p>
If --prune-empty is specified, sometimes empty commits are missed
-and left around anyway (a somewhat rare bug, but it happens…)
+ and left around anyway (a somewhat rare bug, but it happens…)
</p>
</li>
<li>
<p>
A minor issue, but users who have a goal to update all names and
-emails in a repository may be led to --env-filter which will only update
-authors and committers, missing taggers.
+ emails in a repository may be led to --env-filter which will only
+ update authors and committers, missing taggers.
</p>
</li>
<li>
<p>
If the user provides a --tag-name-filter that maps multiple tags to
-the same name, no warning or error is provided; git-filter-branch simply
-overwrites each tag in some undocumented pre-defined order resulting in
-only one tag at the end. (A git-filter-branch regression test requires
-this surprising behavior.)
+ the same name, no warning or error is provided; git-filter-branch
+ simply overwrites each tag in some undocumented pre-defined order
+ resulting in only one tag at the end. (A git-filter-branch
+ regression test requires this surprising behavior.)
</p>
</li>
</ul></div>
@@ -1575,32 +1583,33 @@ issues:</p></div> <div class="ulist"><ul>
<li>
<p>
-Coming up with the correct shell snippet to do the filtering you want
-is sometimes difficult unless you’re just doing a trivial modification
-such as deleting a couple files. Unfortunately, people often learn if
-the snippet is right or wrong by trying it out, but the rightness or
-wrongness can vary depending on special circumstances (spaces in
-filenames, non-ascii filenames, funny author names or emails, invalid
-timezones, presence of grafts or replace objects, etc.), meaning they
-may have to wait a long time, hit an error, then restart. The
-performance of git-filter-branch is so bad that this cycle is painful,
-reducing the time available to carefully re-check (to say nothing about
-what it does to the patience of the person doing the rewrite even if
-they do technically have more time available). This problem is extra
-compounded because errors from broken filters may not be shown for a
-long time and/or get lost in a sea of output. Even worse, broken
-filters often just result in silent incorrect rewrites.
+Coming up with the correct shell snippet to do the filtering you
+ want is sometimes difficult unless you’re just doing a trivial
+ modification such as deleting a couple files. Unfortunately, people
+ often learn if the snippet is right or wrong by trying it out, but
+ the rightness or wrongness can vary depending on special
+ circumstances (spaces in filenames, non-ascii filenames, funny
+ author names or emails, invalid timezones, presence of grafts or
+ replace objects, etc.), meaning they may have to wait a long time,
+ hit an error, then restart. The performance of git-filter-branch is
+ so bad that this cycle is painful, reducing the time available to
+ carefully re-check (to say nothing about what it does to the
+ patience of the person doing the rewrite even if they do technically
+ have more time available). This problem is extra compounded because
+ errors from broken filters may not be shown for a long time and/or
+ get lost in a sea of output. Even worse, broken filters often just
+ result in silent incorrect rewrites.
</p>
</li>
<li>
<p>
-To top it all off, even when users finally find working commands, they
-naturally want to share them. But they may be unaware that their repo
-didn’t have some special cases that someone else’s does. So, when
-someone else with a different repository runs the same commands, they
-get hit by the problems above. Or, the user just runs commands that
-really were vetted for special cases, but they run it on a different OS
-where it doesn’t work, as noted above.
+To top it all off, even when users finally find working commands,
+ they naturally want to share them. But they may be unaware that
+ their repo didn’t have some special cases that someone else’s does.
+ So, when someone else with a different repository runs the same
+ commands, they get hit by the problems above. Or, the user just
+ runs commands that really were vetted for special cases, but they
+ run it on a different OS where it doesn’t work, as noted above.
</p>
</li>
</ul></div>
@@ -1617,7 +1626,7 @@ where it doesn’t work, as noted above. <div id="footer">
<div id="footer-text">
Last updated
- 2019-12-01 14:55:34 PST
+ 2019-12-25 13:09:50 PST
</div>
</div>
</body>
|