{"thread":{"id":"25697","subject":"[PATCH v2] Documentation/git-pull: clarify configuration","startedAt":"2010-11-10T07:13:08Z","lastAt":"2010-11-11T08:31:25Z","messageCount":6,"participants":["Martin von Zweigbergk","Jonathan Nieder","Junio C Hamano"],"isPatch":true,"patchVersion":2,"patchTotal":null},"messages":[{"id":"155589","messageId":"1289373188-32543-1-git-send-email-martin.von.zweigbergk@gmail.com","threadId":"25697","inReplyTo":null,"subject":"[PATCH v2] Documentation/git-pull: clarify configuration","fromName":"Martin von Zweigbergk","fromEmail":"martin.von.zweigbergk@gmail.com","sentAt":"2010-11-10T07:13:08Z","receivedAt":"2010-11-10T07:13:08Z","isPatch":true,"sender":{"key":"martinvonz@gmail.com","avatar":"https://avatars.githubusercontent.com/u/891642?v=4"},"body":"The sentence about 'branch..rebase' refers to the first sentence\nin the paragraph. Clarify by putting it in a separate paragraph.\n\nText provided by Jonathan Nieder.\n\nSigned-off-by: Martin von Zweigbergk \n---\n Documentation/git-pull.txt | 15 +++++++++------\n 1 files changed, 9 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt\nindex c50f7dc..055126e 100644\n--- a/Documentation/git-pull.txt\n+++ b/Documentation/git-pull.txt\n@@ -92,12 +92,15 @@ include::merge-options.txt[]\n :git-pull: 1\n \n --rebase::\n-\tInstead of a merge, perform a rebase after fetching. If\n-\tthere is a remote ref for the upstream branch, and this branch\n-\twas rebased since last fetched, the rebase uses that information\n-\tto avoid rebasing non-local changes. To make this the default\n-\tfor branch ``, set configuration `branch..rebase`\n-\tto `true`.\n+\tInstead of merging, rebase the current branch on top of the\n+\tupstream branch after fetching. If there is a remote-tracking\n+\tbranch corresponding to the upstream branch and the upstream\n+\tbranch was rebased since last fetched, the rebase uses that\n+\tinformation to avoid rebasing non-local changes.\n+\n+\tThe default behavior is to merge rather than rebasing, but it\n+\tcan be overridden per branch with the `branch..rebase`\n+\tconfiguration item (see git-config(1)).\n +\n [NOTE]\n This is a potentially _dangerous_ mode of operation.\n-- \n1.7.3.2.167.ga361b\n"},{"id":"155601","messageId":"20101110172431.GB11513@burratino","threadId":"25697","inReplyTo":"1289373188-32543-1-git-send-email-martin.von.zweigbergk@gmail.com","subject":"Re: [PATCH v2] Documentation/git-pull: clarify configuration","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2010-11-10T17:24:31Z","receivedAt":"2010-11-10T17:24:31Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi again,\n\nMartin von Zweigbergk wrote:\n\n> The sentence about 'branch..rebase' refers to the first sentence\n> in the paragraph. Clarify by putting it in a separate paragraph.\n\nI think the patch clarifies by rewording a little, too. :)\n\n> --- a/Documentation/git-pull.txt\n> +++ b/Documentation/git-pull.txt\n> @@ -92,12 +92,15 @@ include::merge-options.txt[]\n> :git-pull: 1\n> \n> --rebase::\n> -\tInstead of a merge, perform a rebase after fetching. If\n> -\tthere is a remote ref for the upstream branch, and this branch\n> -\twas rebased since last fetched, the rebase uses that information\n> -\tto avoid rebasing non-local changes. To make this the default\n> -\tfor branch ``, set configuration `branch..rebase`\n> -\tto `true`.\n> +\tInstead of merging, rebase the current branch on top of the\n> +\tupstream branch after fetching. If there is a remote-tracking\n> +\tbranch corresponding to the upstream branch and the upstream\n> +\tbranch was rebased since last fetched, the rebase uses that\n> +\tinformation to avoid rebasing non-local changes.\n> +\n> +\tThe default behavior is to merge rather than rebasing, but it\n> +\tcan be overridden per branch with the `branch..rebase`\n> +\tconfiguration item (see git-config(1)).\n> +\n\nDo these changes result in good output with \"make -C Documentation\ngit-pull.1\" or \"make -C Documentation git-pull.html\"? I think it\nmight need to be\n\n\tfirst paragraph\n +\n second paragraph\n +\n third paragraph\n\nor similar.\n\nRegards,\nJonathan\n"},{"id":"155604","messageId":"7voc9xhyfx.fsf@alter.siamese.dyndns.org","threadId":"25697","inReplyTo":"1289373188-32543-1-git-send-email-martin.von.zweigbergk@gmail.com","subject":"Re: [PATCH v2] Documentation/git-pull: clarify configuration","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2010-11-10T17:37:38Z","receivedAt":"2010-11-10T17:37:38Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Martin von Zweigbergk writes:\n\n> diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt\n> index c50f7dc..055126e 100644\n> --- a/Documentation/git-pull.txt\n> +++ b/Documentation/git-pull.txt\n> @@ -92,12 +92,15 @@ include::merge-options.txt[]\n> :git-pull: 1\n> \n> --rebase::\n> -\tInstead of a merge, perform a rebase after fetching. If\n> -\tthere is a remote ref for the upstream branch, and this branch\n> -\twas rebased since last fetched, the rebase uses that information\n> -\tto avoid rebasing non-local changes. To make this the default\n> -\tfor branch ``, set configuration `branch..rebase`\n> -\tto `true`.\n> +\tInstead of merging, rebase the current branch on top of the\n> +\tupstream branch after fetching. If there is a remote-tracking\n> +\tbranch corresponding to the upstream branch and the upstream\n> +\tbranch was rebased since last fetched, the rebase uses that\n> +\tinformation to avoid rebasing non-local changes.\n> +\n> +\tThe default behavior is to merge rather than rebasing, but it\n> +\tcan be overridden per branch with the `branch..rebase`\n> +\tconfiguration item (see git-config(1)).\n\nThe explanation looks correct in the sense that it does not say anything\nincorrect, and the description of non-local change exclusion in the first\nparagraph is more readable, I think.\n\nBut I am not sure if we want a separate paragraph here only to repeat a\nhalf of what the second paragraph in the DESCRIPTION section already said.\nThe \"default is merge\" is implied by \"Instead of merging\" at the beginnig\nof this part anyway.\n\nAlso have you tried to actually format this and checked the result before\nsubmitting the patch?\n\nPerhaps doing it like this may be better (no I didn't run AsciiDoc on it).\n\n\n--rebase::\n\tRebase the current branch on top of the upstream branch after\n fetching. If there is a remote-tracking branch corresponding to\n the upstream branch and the upstream branch was rebased since last\n fetched, the rebase uses that information to avoid rebasing\n non-local changes.\n+\nSee `branch..rebase` in linkgit:git-config[1] if you want to make\n`git pull` always use `{litdd}rebase` instead of merging.\n"},{"id":"155641","messageId":"AANLkTikT4N5JAxRxPCbx=xAokRKOvvxDQ4pAC9CcpObB@mail.gmail.com","threadId":"25697","inReplyTo":"7voc9xhyfx.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH v2] Documentation/git-pull: clarify configuration","fromName":"Martin von Zweigbergk","fromEmail":"martin.von.zweigbergk@gmail.com","sentAt":"2010-11-11T01:43:29Z","receivedAt":"2010-11-11T01:43:29Z","isPatch":true,"sender":{"key":"martinvonz@gmail.com","avatar":"https://avatars.githubusercontent.com/u/891642?v=4"},"body":"On Wed, Nov 10, 2010 at 12:37 PM, Junio C Hamano wrote:\n> Martin von Zweigbergk writes:\n>\n>> diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt\n>> index c50f7dc..055126e 100644\n>> --- a/Documentation/git-pull.txt\n>> +++ b/Documentation/git-pull.txt\n>> @@ -92,12 +92,15 @@ include::merge-options.txt[]\n>>  :git-pull: 1\n>>\n>>  --rebase::\n>> -     Instead of a merge, perform a rebase after fetching.  If\n>> -     there is a remote ref for the upstream branch, and this branch\n>> -     was rebased since last fetched, the rebase uses that information\n>> -     to avoid rebasing non-local changes. To make this the default\n>> -     for branch ``, set configuration `branch..rebase`\n>> -     to `true`.\n>> +     Instead of merging, rebase the current branch on top of the\n>> +     upstream branch after fetching.  If there is a remote-tracking\n>> +     branch corresponding to the upstream branch and the upstream\n>> +     branch was rebased since last fetched, the rebase uses that\n>> +     information to avoid rebasing non-local changes.\n>> +\n>> +     The default behavior is to merge rather than rebasing, but it\n>> +     can be overridden per branch with the `branch..rebase`\n>> +     configuration item (see git-config(1)).\n>\n> The explanation looks correct in the sense that it does not say anything\n> incorrect, and the description of non-local change exclusion in the first\n> paragraph is more readable, I think.\n>\n> But I am not sure if we want a separate paragraph here only to repeat a\n> half of what the second paragraph in the DESCRIPTION section already said.\n> The \"default is merge\" is implied by \"Instead of merging\" at the beginnig\n> of this part anyway.\n>\n> Also have you tried to actually format this and checked the result before\n> submitting the patch?\n>\n> Perhaps doing it like this may be better (no I didn't run AsciiDoc on it).\n>\n>\n> --rebase::\n>        Rebase the current branch on top of the upstream branch after\n>        fetching.  If there is a remote-tracking branch corresponding to\n>        the upstream branch and the upstream branch was rebased since last\n>        fetched, the rebase uses that information to avoid rebasing\n>        non-local changes.\n> +\n> See `branch..rebase` in linkgit:git-config[1] if you want to make\n> `git pull` always use `{litdd}rebase` instead of merging.\n\nI'm happy with either your suggestion or Jonathan's. Do you want me to\nsend an updated patch to the list or will you make the change directly?\n\nWhile writing a reply to another message, I happened to spot a similar\nproblem in the documentation for 'git rebase -s'. It currently says \"Use\nthe given merge strategy. If there is no -s option git merge-recursive\nis used instead. This implies --merge.\" and I assume the last sentence\nrefers to the first one in this case too. Same question here: Should I\nsend a patch?\n"},{"id":"155643","messageId":"AANLkTi=2XtadM6=BOih-EUBgQk5Kd==CYmL5YgHto8S6@mail.gmail.com","threadId":"25697","inReplyTo":"20101110172431.GB11513@burratino","subject":"Re: [PATCH v2] Documentation/git-pull: clarify configuration","fromName":"Martin von Zweigbergk","fromEmail":"martin.von.zweigbergk@gmail.com","sentAt":"2010-11-11T01:50:00Z","receivedAt":"2010-11-11T01:50:00Z","isPatch":true,"sender":{"key":"martinvonz@gmail.com","avatar":"https://avatars.githubusercontent.com/u/891642?v=4"},"body":"On Wed, Nov 10, 2010 at 12:24 PM, Jonathan Nieder wrote:\n> Hi again,\n>\n> Martin von Zweigbergk wrote:\n>\n>> The sentence about 'branch..rebase' refers to the first sentence\n>> in the paragraph. Clarify by putting it in a separate paragraph.\n>\n> I think the patch clarifies by rewording a little, too. :)\n\nYes, you are right :-). Will improve it in version 3, if I'm asked to\nprovide that.\n\n>> --- a/Documentation/git-pull.txt\n>> +++ b/Documentation/git-pull.txt\n>> @@ -92,12 +92,15 @@ include::merge-options.txt[]\n>>  :git-pull: 1\n>>\n>>  --rebase::\n>> -     Instead of a merge, perform a rebase after fetching.  If\n>> -     there is a remote ref for the upstream branch, and this branch\n>> -     was rebased since last fetched, the rebase uses that information\n>> -     to avoid rebasing non-local changes. To make this the default\n>> -     for branch ``, set configuration `branch..rebase`\n>> -     to `true`.\n>> +     Instead of merging, rebase the current branch on top of the\n>> +     upstream branch after fetching.  If there is a remote-tracking\n>> +     branch corresponding to the upstream branch and the upstream\n>> +     branch was rebased since last fetched, the rebase uses that\n>> +     information to avoid rebasing non-local changes.\n>> +\n>> +     The default behavior is to merge rather than rebasing, but it\n>> +     can be overridden per branch with the `branch..rebase`\n>> +     configuration item (see git-config(1)).\n>>  +\n>\n> Do these changes result in good output with \"make -C Documentation\n> git-pull.1\" or \"make -C Documentation git-pull.html\"?  I think it\n> might need to be\n>\n>        first paragraph\n>  +\n>  second paragraph\n>  +\n>  third paragraph\n>\n> or similar.\n>\n\nOops, that's embarrassing... but thanks for the hints. I did not know\nthat.\n"},{"id":"155656","messageId":"20101111083124.GB15525@burratino","threadId":"25697","inReplyTo":"AANLkTikT4N5JAxRxPCbx=xAokRKOvvxDQ4pAC9CcpObB@mail.gmail.com","subject":"Re: [PATCH v2] Documentation/git-pull: clarify configuration","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2010-11-11T08:31:25Z","receivedAt":"2010-11-11T08:31:25Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Martin von Zweigbergk wrote:\n\n> I happened to spot a similar\n> problem in the documentation for 'git rebase -s'. It currently says \"Use\n> the given merge strategy. If there is no -s option git merge-recursive\n> is used instead. This implies --merge.\" and I assume the last sentence\n> refers to the first one in this case too. Same question here: Should I\n> send a patch?\n\nYes, please!\n\nIn general, carefully written patches that improve the documentation\nare always welcome. (And sloppy patches are not so bad, either.)\n"}]}