Re: [PATCH] Documentation/git-pull: clarify configuration

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Nov 10, 2010, 03:48 UTC
Message-ID: <20101110034846.GB2401@burratino>
In-Reply-To: <1289336209-28222-1-git-send-email-martin.von.zweigbergk@gmail.com>

Martin von Zweigbergk wrote:

> The sentence about 'branch.<name>.rebase' refers to the first sentence
> in the paragraph. Clarify by moving it right after that sentence.

Sane.

Show 15 quoted lines

> --- a/Documentation/git-pull.txt
> +++ b/Documentation/git-pull.txt
> @@ -92,12 +92,11 @@ include::merge-options.txt[]
>  :git-pull: 1
>  
>  --rebase::
> -	Instead of a merge, perform a rebase after fetching.  If
> -	there is a remote ref for the upstream branch, and this branch
> -	was rebased since last fetched, the rebase uses that information
> -	to avoid rebasing non-local changes. To make this the default
> -	for branch `<name>`, set configuration `branch.<name>.rebase`
> -	to `true`.
> +	Instead of a merge, perform a rebase after fetching. To make this
> +	the default for branch `<name>`, set configuration
> +	`branch.<name>.rebase` to `true`.

Grammatically, the narrator first gives an order to the git program ("perform a rebase") and then to the person configuring it ("set the configuration"). Maybe it would be clearer to focus on what the program does in this case?

	Instead of merging, rebase the current branch on top of the
	upstream branch after fetching.  If there is a remote-tracking
	branch corresponding to the upstream branch and the upstream
	branch was rebased since last fetched, the rebase uses that
	information to avoid rebasing non-local changes.

	The default behavior is to merge rather than rebasing, but it
	can be overridden per branch with the `branch.<name>.rebase`
	configuration item (see git-config(1)).