{"thread":{"id":"9724","subject":"[PATCH] filter-branch: fix remnants of old syntax in documentation","startedAt":"2007-08-31T16:42:33Z","lastAt":"2007-08-31T16:42:33Z","messageCount":1,"participants":["Johannes Schindelin"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"52058","messageId":"Pine.LNX.4.64.0708311742150.28586@racer.site","threadId":"9724","inReplyTo":null,"subject":"[PATCH] filter-branch: fix remnants of old syntax in documentation","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2007-08-31T16:42:33Z","receivedAt":"2007-08-31T16:42:33Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"\nSome time ago, filter-branch's syntax changed so that more than one\nref can be rewritten at the same time.  This involved the removal of\nthe ref name for the result; instead, the refs are rewritten in-place.\n\nThis updates the last leftovers in the documentation to reflect the\nnew behavior.\n\nSigned-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>\n---\n Documentation/git-filter-branch.txt |   32 ++++++++++++++++++--------------\n 1 files changed, 18 insertions(+), 14 deletions(-)\n\ndiff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt\nindex ae03514..4f89c04 100644\n--- a/Documentation/git-filter-branch.txt\n+++ b/Documentation/git-filter-branch.txt\n@@ -17,19 +17,19 @@ SYNOPSIS\n \n DESCRIPTION\n -----------\n-Lets you rewrite git revision history by creating a new branch from\n-your current branch, applying custom filters on each revision.\n+Lets you rewrite git revision history by rewriting the branches mentioned\n+in the <rev-list options>, applying custom filters on each revision.\n Those filters can modify each tree (e.g. removing a file or running\n a perl rewrite on all files) or information about each commit.\n Otherwise, all information (including original commit times or merge\n information) will be preserved.\n \n-The command takes the new branch name as a mandatory argument and\n-the filters as optional arguments.  If you specify no filters, the\n-commits will be recommitted without any changes, which would normally\n-have no effect.  Nevertheless, this may be useful in the future for\n-compensating for some git bugs or such, therefore such a usage is\n-permitted.\n+The command will only rewrite the _positive_ refs mentioned in the\n+command line (i.e. if you pass 'a..b', only 'b' will be rewritten).\n+If you specify no filters, the commits will be recommitted without any\n+changes, which would normally have no effect.  Nevertheless, this may be\n+useful in the future for compensating for some git bugs or such,\n+therefore such a usage is permitted.\n \n *WARNING*! The rewritten history will have different object names for all\n the objects and will not converge with the original branch.  You will not\n@@ -43,8 +43,8 @@ if different from the rewritten ones, will be stored in the namespace\n 'refs/original/'.\n \n Note that since this operation is extensively I/O expensive, it might\n-be a good idea to redirect the temporary directory off-disk, e.g. on\n-tmpfs.  Reportedly the speedup is very noticeable.\n+be a good idea to redirect the temporary directory off-disk with the\n+'-d' option, e.g. on tmpfs.  Reportedly the speedup is very noticeable.\n \n \n Filters\n@@ -112,6 +112,9 @@ OPTIONS\n As a special extension, the commit filter may emit multiple\n commit ids; in that case, ancestors of the original commit will\n have all of them as parents.\n++\n+Note that the 'map' function is not available in the commit filter yet.\n+This will be changed in a future version.\n \n --tag-name-filter <command>::\n \tThis is the filter for rewriting tag names. When passed,\n@@ -186,8 +189,8 @@ order to paste the other history behind the current history:\n git filter-branch --parent-filter 'sed \"s/^\\$/-p <graft-id>/\"' HEAD\n -------------------------------------------------------------------\n \n-(if the parent string is empty - therefore we are dealing with the\n-initial commit - add graftcommit as a parent).  Note that this assumes\n+(if the parent string is empty - which happens when we are dealing with\n+the initial commit - add graftcommit as a parent).  Note that this assumes\n history with a single root (that is, no merge without common ancestors\n happened).  If this is not the case, use:\n \n@@ -232,11 +235,12 @@ range in addition to the new branch name.  The new branch name will\n point to the top-most revision that a 'git rev-list' of this range\n will print.\n \n-Note that the changes introduced by the commits, and not reverted by\n-subsequent commits, will still be in the rewritten branch. If you want\n+*NOTE* the changes introduced by the commits, and which are not reverted\n+by subsequent commits, will still be in the rewritten branch. If you want\n to throw out _changes_ together with the commits, you should use the\n interactive mode of gitlink:git-rebase[1].\n \n+\n Consider this history:\n \n ------------------\n-- \n1.5.3.rc7.18.gc9b59\n"}]}