Re: [PATCH] Documentation/git-filter-branch: add a new commit-filter example

[Junio C Hamano <gitster@pobox.com>]

Miklos Vajna <vmiklos@frugalware.org> writes:

> There is a commit-filter example already which skips commits but there is no
> example on how to edit commit messages.
>
> One can figure out this example by carefully reading the git-filter-branch and
> git-commit-tree documentation but I think it isn't trivial so this example is
> helpful.
>
> Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
> ---
>
> The lack of such an example was noticed by dvorak on IRC.
>
>  Documentation/git-filter-branch.txt |    6 ++++++
>  1 files changed, 6 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
> index e22dfa5..a035b9c 100644
> --- a/Documentation/git-filter-branch.txt
> +++ b/Documentation/git-filter-branch.txt
> @@ -240,6 +240,12 @@ 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.
>  
> +To remove the 'git-svn-id' strings from commit messages in a repository created
> +by git-svn:

People who are not interested in git-svn at all may still want
to fix up their commit log messages, and I think starting a
paragraph with 'git-svn-blah' would risk them skipping it
without reading (I certainly would).  Probably we would want to
add a sentence before "To remove ...", like this:

	You can rewrite the commit log messages using `--commit-filter`.
	For example, `git-svn-id` strings in a repository created with
	`git-svn` can be cleaned up this way:

> +------------------------------------------------------------------------------
> +git filter-branch --commit-filter 'sed "/^git-svn-id:/d" |git commit-tree "$@"'
> +------------------------------------------------------------------------------

Please try to keep them a bit shorter for reviewing pleasure on
80-column terminals after your message was quoted once or
perhaps a few times.  The example is easier to read if you write
like this, I think:

----------------------------------------------------------------
git filter-branch --commit-filter '
	sed -e "/^git-svn-id:/d" | git commit-tree "$@"
'
----------------------------------------------------------------

I am not sure if git-svn people condone or encourage such
removals, though.