git-submodule - Allow adding a submodule in-place

[git.git] / Documentation / git-filter-branch.txt

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 895d7503100632f5ab79af548fed3b3a6d79c413..543a1cf105b6df5953e529ecb4f9f88db273164f 100644 (file)
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -56,7 +56,9 @@ notable exception of the commit filter, for technical reasons).
 Prior to that, the $GIT_COMMIT environment variable will be set to contain
 the id of the commit being rewritten.  Also, GIT_AUTHOR_NAME,
 GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
-and GIT_COMMITTER_DATE are set according to the current commit.
+and GIT_COMMITTER_DATE are set according to the current commit. If any
+evaluation of <command> returns a non-zero exit status, the whole operation
+will be aborted.
 
 A 'map' function is available that takes an "original sha1 id" argument
 and outputs a "rewritten sha1 id" if the commit has been already
@@ -72,7 +74,7 @@ OPTIONS
        This is the filter for modifying the environment in which
        the commit will be performed.  Specifically, you might want
        to rewrite the author/committer name/email/time environment
-       variables (see gitlink:git-commit[1] for details).  Do not forget
+       variables (see linkgit:git-commit[1] for details).  Do not forget
        to re-export the variables.
 
 --tree-filter <command>::
@@ -86,13 +88,13 @@ OPTIONS
 --index-filter <command>::
        This is the filter for rewriting the index.  It is similar to the
        tree filter but does not check out the tree, which makes it much
-       faster.  For hairy cases, see gitlink:git-update-index[1].
+       faster.  For hairy cases, see linkgit:git-update-index[1].
 
 --parent-filter <command>::
        This is the filter for rewriting the commit's parent list.
        It will receive the parent string on stdin and shall output
        the new parent string on stdout.  The parent string is in
-       a format accepted by gitlink:git-commit-tree[1]: empty for
+       a format accepted by linkgit:git-commit-tree[1]: empty for
        the initial commit, "-p parent" for a normal commit and
        "-p parent1 -p parent2 -p parent3 ..." for a merge commit.
 
@@ -105,7 +107,7 @@ OPTIONS
 --commit-filter <command>::
        This is the filter for performing the commit.
        If this filter is specified, it will be called instead of the
-       gitlink:git-commit-tree[1] command, with arguments of the form
+       linkgit:git-commit-tree[1] command, with arguments of the form
        "<TREE_ID> [-p <PARENT_COMMIT_ID>]..." and the log message on
        stdin.  The commit id is expected on stdout.
 +
@@ -116,7 +118,7 @@ have all of them as parents.
 You can use the 'map' convenience function in this filter, and other
 convenience functions, too.  For example, calling 'skip_commit "$@"'
 will leave out the current commit (but not its changes! If you want
-that, use gitlink:git-rebase[1] instead).
+that, use linkgit:git-rebase[1] instead).
 
 --tag-name-filter <command>::
        This is the filter for rewriting tag names. When passed,
@@ -159,7 +161,7 @@ definition impossible to preserve signatures at any rate.)
 
 <rev-list-options>::
        When options are given after the new branch name, they will
-       be passed to gitlink:git-rev-list[1].  Only commits in the resulting
+       be passed to linkgit:git-rev-list[1].  Only commits in the resulting
        output will be filtered, although the filtered commits can still
        reference parents which are outside of that set.
 
@@ -197,7 +199,7 @@ happened).  If this is not the case, use:
 
 --------------------------------------------------------------------------
 git filter-branch --parent-filter \
-       'cat; test $GIT_COMMIT = <commit-id> && echo "-p <graft-id>"' HEAD
+       'test $GIT_COMMIT = <commit-id> && echo "-p <graft-id>" || cat' HEAD
 --------------------------------------------------------------------------
 
 or even simpler:
@@ -240,6 +242,15 @@ committed a merge between P1 and P2, it will be propagated properly
 and all children of the merge will become merge commits with P1,P2
 as their parents instead of the merge commit.
 
+You can rewrite the commit log messages using `--message-filter`.  For
+example, `git-svn-id` strings in a repository created by `git-svn` can
+be removed this way:
+
+-------------------------------------------------------
+git filter-branch --message-filter '
+       sed -e "/^git-svn-id:/d"
+'
+-------------------------------------------------------
 
 To restrict rewriting to only part of the history, specify a revision
 range in addition to the new branch name.  The new branch name will
@@ -249,7 +260,7 @@ will print.
 *NOTE* the changes introduced by the commits, and which are not reverted
 by subsequent commits, will still be in the rewritten branch. If you want
 to throw out _changes_ together with the commits, you should use the
-interactive mode of gitlink:git-rebase[1].
+interactive mode of linkgit:git-rebase[1].
 
 
 Consider this history:
@@ -295,4 +306,4 @@ Documentation by Petr Baudis and the git list.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite