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

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 21, 2011, 18:42 UTC
Message-ID: <7vhb6f326s.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1311261052-16178-1-git-send-email-peter@pcc.me.uk>

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

Show 21 quoted lines

> 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.