path: root/Documentation/git-filter-branch.txt
AgeCommit message (Collapse)Author
2008-02-26filter-branch documentation: non-zero exit status in command abort the filterCaio Marcelo de Oliveira Filho
Since commit 8c1ce0f46b85d40f215084eed7313896300082df filter-branch fails when a <command> has a non-zero exit status. This commit makes it clear in the documentation and also fixes the parent-filter example, that was incorrectly returning non-zero when the commit being tested wasn't the one to be rewritten. Signed-off-by: Caio Marcelo de Oliveira Filho <> Signed-off-by: Junio C Hamano <>
2008-02-25Documentation/git-filter-branch: add a new msg-filter exampleMiklos Vajna
There were no example on how to edit commit messages, so add an msg-filter example. Signed-off-by: Miklos Vajna <> Signed-off-by: Junio C Hamano <>
2008-01-31Revert "filter-branch docs: remove brackets so not to imply revision arg is ↵Junio C Hamano
optional" This reverts commit c41b439244c51b30c60953192816afc91e552578, as we decided to default to HEAD when revision parameters are missing and they are no longer mandatory.
2008-01-31filter-branch docs: remove brackets so not to imply revision arg is optionalBrandon Casey
Signed-off-by: Brandon Casey <> Signed-off-by: Junio C Hamano <>
2008-01-07Documentation: rename gitlink macro to linkgitDan McGee
Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee <> Signed-off-by: Junio C Hamano <>
2007-11-02Remove escaping of '|' in manpage option sectionsJonas Fonseca
The escaped were ending up verbatim in the generated documentation. Signed-off-by: Jonas Fonseca <> Signed-off-by: Junio C Hamano <>
2007-11-01git-filter-branch.txt: fix a typo.Sergei Organov
Signed-off-by: Sergei Organov <> Acked-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-10-17fix filter-branch documentationJohannes Schindelin
The man page for filter-branch still talked about writing the result to the branch "newbranch". This is hopefully the last place where the old behaviour was described. Noticed by Bill Lear. Signed-off-by: Johannes Schindelin <> Signed-off-by: Shawn O. Pearce <>
2007-09-14Remove duplicate note about removing commits with git-filter-branchUlrik Sverdrup
A duplicate of an already existing section in the documentation of git-filter-branch was added in commit f95eef15f2f8a336b9a42749f5458c841a5a5d63. This patch removes that redundant section. Signed-off-by: Ulrik Sverdrup <> Signed-off-by: Junio C Hamano <>
2007-09-01filter-branch: introduce convenience function "skip_commit"Johannes Schindelin
With this function, a commit filter can leave out unwanted commits (such as temporary commits). It does _not_ undo the changeset corresponding to that commit, but it _skips_ the revision. IOW no tree object is changed by this. If you like to commit early and often, but want to filter out all intermediate commits, marked by "@@@" in the commit message, you can now do this with git filter-branch --commit-filter ' if git cat-file commit $GIT_COMMIT | grep '@@@' > /dev/null; then skip_commit "$@"; else git commit-tree "$@"; fi' newbranch Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-09-01filter-branch: provide the convenience functions also for commit filtersJohannes Schindelin
Move the convenience functions to the top of, and return from the script when the environment variable SOURCE_FUNCTIONS is set. By sourcing git-filter-branch with that variable set automatically, all commit filters may access the convenience functions like "map". Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-09-01filter-branch: fix remnants of old syntax in documentationJohannes Schindelin
Some time ago, filter-branch's syntax changed so that more than one ref can be rewritten at the same time. This involved the removal of the ref name for the result; instead, the refs are rewritten in-place. This updates the last leftovers in the documentation to reflect the new behavior. Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-08-31git-filter-branch: document --original optionGiuseppe Bilotta
Signed-off-by: Giuseppe Bilotta <> Signed-off-by: Junio C Hamano <>
2007-08-17Minor clarifications to git-filter-branch usage and docBrian Gernhardt
- Remove "DESTBRANCH" from usage, as it rewrites the branches given. - Remove an = from an example usage, as the script doesn't understand it. Signed-off-by: Brian Gernhardt <> Signed-off-by: Junio C Hamano <>
2007-07-24filter-branch: Big syntax change; support rewriting multiple refsJohannes Schindelin
We used to take the first non-option argument as the name for the new branch. This syntax is not extensible to support rewriting more than just HEAD. Instead, we now have the following syntax: git filter-branch [<filter options>...] [<rev-list options>] All positive refs given in <rev-list options> are rewritten. Yes, in-place. If a ref was changed, the original head is stored in refs/original/$ref now, for your inspecting pleasure, in addition to the reflogs (since it is easier to inspect "git show-ref | grep original" than to inspect all the reflogs). This commit also adds the --force option to remove .git-rewrite/ and all refs from refs/original/ before filtering. Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-07-06filter-branch documentation: clarify which filters are eval'edJohannes Schindelin
All filters, except the commit filter, are evaluated. Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-07-04filter-branch documentation: some more touch-ups.Johannes Sixt
- The map function used to fail, but no longer does (since 3520e1e8687.) - Fix the "edge-graft" example. - Show the same using .git/info/grafts. Signed-off-by: Johannes Sixt <> Signed-off-by: Junio C Hamano <>
2007-07-04filter-branch: a few more touch ups to the man pageJohannes Schindelin
All based on comments from Frank Lichtenheld. Signed-off-by: Johannes Schindelin <> Acked-by: Frank Lichtenheld <> Signed-off-by: Junio C Hamano <>
2007-07-04Document git-filter-branchJohannes Schindelin
This moves the documentation in to its own man page, with a few touch ups (incorporating comments by Frank Lichtenheld). Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>