[PATCH] Documentation: git-filter-branch honors replacement refs

[PATCH] Documentation: git-filter-branch honors replacement refs

[Peter Collingbourne]

Make it clear that git-filter-branch will honor and make permanent
replacement refs as well as grafts.

Signed-off-by: Peter Collingbourne <peter@pcc.me.uk>
---
 Documentation/git-filter-branch.txt |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 9dc1f2a..0f2f117 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -32,8 +32,9 @@ changes, which would normally have no effect.  Nevertheless, this may be
 useful in the future for compensating for some git bugs or such,
 therefore such a usage is permitted.
 
-*NOTE*: This command honors `.git/info/grafts`. If you have any grafts
-defined, running this command will make them permanent.
+*NOTE*: This command honors `.git/info/grafts` and `.git/refs/replace/`.
+If you have any grafts or replacement refs defined, running this command
+will make them permanent.
 
 *WARNING*! The rewritten history will have different object names for all
 the objects and will not converge with the original branch.  You will not
-- 
1.7.5.3

Re: [PATCH] Documentation: git-filter-branch honors replacement refs

[Junio C Hamano]

Peter Collingbourne <peter@pcc.me.uk> writes:

> Make it clear that git-filter-branch will honor and make permanent
> replacement refs as well as grafts.
>
> Signed-off-by: Peter Collingbourne <peter@pcc.me.uk>
> ---
>  Documentation/git-filter-branch.txt |    5 +++--
>  1 files changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
> index 9dc1f2a..0f2f117 100644
> --- a/Documentation/git-filter-branch.txt
> +++ b/Documentation/git-filter-branch.txt
> @@ -32,8 +32,9 @@ changes, which would normally have no effect.  Nevertheless, this may be
>  useful in the future for compensating for some git bugs or such,
>  therefore such a usage is permitted.
>  
> -*NOTE*: This command honors `.git/info/grafts`. If you have any grafts
> -defined, running this command will make them permanent.
> +*NOTE*: This command honors `.git/info/grafts` and `.git/refs/replace/`.
> +If you have any grafts or replacement refs defined, running this command
> +will make them permanent.

Looks good. I think the second sentence can be further clarified,
though. One of the reasons you may want to run this command is to make
them permanent, so perhaps

	Use this command to make your grafts and replacements permanent.

or something like that.