{"thread":{"id":"51325","subject":"[PATCH] show --continue/skip etc. consistently in synopsis","startedAt":"2019-06-16T13:25:19Z","lastAt":"2019-06-17T22:35:37Z","messageCount":7,"participants":["Phillip Wood","Junio C Hamano","Elijah Newren"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"377318","messageId":"20190616132457.19413-1-phillip.wood123@gmail.com","threadId":"51325","inReplyTo":null,"subject":"[PATCH] show --continue/skip etc. consistently in synopsis","fromName":"Phillip Wood","fromEmail":"phillip.wood123@gmail.com","sentAt":"2019-06-16T13:24:57Z","receivedAt":"2019-06-16T13:25:19Z","isPatch":true,"sender":{"key":"phillip.wood@dunelm.org.uk","avatar":null},"body":"From: Phillip Wood <phillip.wood@dunelm.org.uk>\n\nThe synopsis for am shows the command mode options as\n    (--continue | --skip | --abort | --quit)\nThey are on a single line and in parenthesis as they are not\noptional. Fix the merge and rebase docs to match this style.\n---\nThis patch is based on top of nd/merge-quit.\nThe docs for cherry-pick/revert are updated to this style by\nhttps://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u\n\nDocumentation/git-merge.txt  | 3 +--\n Documentation/git-rebase.txt | 2 +-\n 2 files changed, 2 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\nindex b7d581fc76..07ca9fb78c 100644\n--- a/Documentation/git-merge.txt\n+++ b/Documentation/git-merge.txt\n@@ -13,8 +13,7 @@ SYNOPSIS\n \t[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]\n \t[--[no-]allow-unrelated-histories]\n \t[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]\n-'git merge' --abort\n-'git merge' --continue\n+'git merge' (--continue | --skip | --abort | --quit)\n \n DESCRIPTION\n -----------\ndiff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\nindex 5629ba4c5d..a67d40596a 100644\n--- a/Documentation/git-rebase.txt\n+++ b/Documentation/git-rebase.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n \t[<upstream> [<branch>]]\n 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]\n \t--root [<branch>]\n-'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch\n+'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)\n \n DESCRIPTION\n -----------\n-- \n2.22.0\n\n"},{"id":"377337","messageId":"xmqq36k9tb30.fsf@gitster-ct.c.googlers.com","threadId":"51325","inReplyTo":"20190616132457.19413-1-phillip.wood123@gmail.com","subject":"Re: [PATCH] show --continue/skip etc. consistently in synopsis","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-06-16T22:33:07Z","receivedAt":"2019-06-16T22:33:18Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Phillip Wood <phillip.wood123@gmail.com> writes:\n\n> From: Phillip Wood <phillip.wood@dunelm.org.uk>\n>\n> The synopsis for am shows the command mode options as\n>     (--continue | --skip | --abort | --quit)\n> They are on a single line and in parenthesis as they are not\n> optional. Fix the merge and rebase docs to match this style.\n\nIs it so clear-cut that it is more \"correct\" to have everything on a\nsingle line, as opposed to describing each one per line?  I am not\nsure.  \n\nI would say both the above style and the style used by \"git merge\"\ndocumentation are correct.  The \"rebase\" one is a different story\nand the change in this patch deserves to be called a \"fix\".\n\nAs long as the more concise \"am\" style is already prevalent (are\nthere pages other than \"am\" you can cite?), I would agree with you\nthat the change to \"git merge\" in this patch is a good idea for\nconsistency's sake.\n\n> ---\n> This patch is based on top of nd/merge-quit.\n\nThanks for indicating where it should go.  We need your sign-off,\ntoo.\n\n\n\n> The docs for cherry-pick/revert are updated to this style by\n> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u\n>\n> Documentation/git-merge.txt  | 3 +--\n>  Documentation/git-rebase.txt | 2 +-\n>  2 files changed, 2 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\n> index b7d581fc76..07ca9fb78c 100644\n> --- a/Documentation/git-merge.txt\n> +++ b/Documentation/git-merge.txt\n> @@ -13,8 +13,7 @@ SYNOPSIS\n>  \t[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]\n>  \t[--[no-]allow-unrelated-histories]\n>  \t[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]\n> -'git merge' --abort\n> -'git merge' --continue\n> +'git merge' (--continue | --skip | --abort | --quit)\n>  \n>  DESCRIPTION\n>  -----------\n> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\n> index 5629ba4c5d..a67d40596a 100644\n> --- a/Documentation/git-rebase.txt\n> +++ b/Documentation/git-rebase.txt\n> @@ -12,7 +12,7 @@ SYNOPSIS\n>  \t[<upstream> [<branch>]]\n>  'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]\n>  \t--root [<branch>]\n> -'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch\n> +'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)\n>  \n>  DESCRIPTION\n>  -----------\n"},{"id":"377342","messageId":"CABPp-BFAJtY2Bzow6T6kYoFqYifKzMinmjF0_EJa-fepcWcppQ@mail.gmail.com","threadId":"51325","inReplyTo":"20190616132457.19413-1-phillip.wood123@gmail.com","subject":"Re: [PATCH] show --continue/skip etc. consistently in synopsis","fromName":"Elijah Newren","fromEmail":"newren@gmail.com","sentAt":"2019-06-17T02:02:42Z","receivedAt":"2019-06-17T02:02:55Z","isPatch":true,"sender":{"key":"newren@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5455730?v=4"},"body":"On Sun, Jun 16, 2019 at 6:29 AM Phillip Wood <phillip.wood123@gmail.com> wrote:\n>\n> From: Phillip Wood <phillip.wood@dunelm.org.uk>\n>\n> The synopsis for am shows the command mode options as\n>     (--continue | --skip | --abort | --quit)\n> They are on a single line and in parenthesis as they are not\n> optional. Fix the merge and rebase docs to match this style.\n\nThanks for working to make this more consistent.  One minor issue...\n\n> ---\n> This patch is based on top of nd/merge-quit.\n> The docs for cherry-pick/revert are updated to this style by\n> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u\n>\n> Documentation/git-merge.txt  | 3 +--\n>  Documentation/git-rebase.txt | 2 +-\n>  2 files changed, 2 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\n> index b7d581fc76..07ca9fb78c 100644\n> --- a/Documentation/git-merge.txt\n> +++ b/Documentation/git-merge.txt\n> @@ -13,8 +13,7 @@ SYNOPSIS\n>         [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]\n>         [--[no-]allow-unrelated-histories]\n>         [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]\n> -'git merge' --abort\n> -'git merge' --continue\n> +'git merge' (--continue | --skip | --abort | --quit)\n\nmerge --skip?  I think you meant to just add --quit here, but copied\nfrom elsewhere and accidentally inserted --skip?\n"},{"id":"377351","messageId":"1a005f73-f620-19ea-d0d7-88621597bcae@gmail.com","threadId":"51325","inReplyTo":"CABPp-BFAJtY2Bzow6T6kYoFqYifKzMinmjF0_EJa-fepcWcppQ@mail.gmail.com","subject":"Re: [PATCH] show --continue/skip etc. consistently in synopsis","fromName":"Phillip Wood","fromEmail":"phillip.wood123@gmail.com","sentAt":"2019-06-17T09:11:06Z","receivedAt":"2019-06-17T09:11:01Z","isPatch":true,"sender":{"key":"phillip.wood@dunelm.org.uk","avatar":null},"body":"On 17/06/2019 03:02, Elijah Newren wrote:\n> On Sun, Jun 16, 2019 at 6:29 AM Phillip Wood <phillip.wood123@gmail.com> wrote:\n>>\n>> From: Phillip Wood <phillip.wood@dunelm.org.uk>\n>>\n>> The synopsis for am shows the command mode options as\n>>     (--continue | --skip | --abort | --quit)\n>> They are on a single line and in parenthesis as they are not\n>> optional. Fix the merge and rebase docs to match this style.\n> \n> Thanks for working to make this more consistent.  One minor issue...\n> \n>> ---\n>> This patch is based on top of nd/merge-quit.\n>> The docs for cherry-pick/revert are updated to this style by\n>> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u\n>>\n>> Documentation/git-merge.txt  | 3 +--\n>>  Documentation/git-rebase.txt | 2 +-\n>>  2 files changed, 2 insertions(+), 3 deletions(-)\n>>\n>> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\n>> index b7d581fc76..07ca9fb78c 100644\n>> --- a/Documentation/git-merge.txt\n>> +++ b/Documentation/git-merge.txt\n>> @@ -13,8 +13,7 @@ SYNOPSIS\n>>         [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]\n>>         [--[no-]allow-unrelated-histories]\n>>         [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]\n>> -'git merge' --abort\n>> -'git merge' --continue\n>> +'git merge' (--continue | --skip | --abort | --quit)\n> \n> merge --skip?  I think you meant to just add --quit here, but copied\n> from elsewhere and accidentally inserted --skip?\n\nThanks, you're right I got a bit carried away with copying and pasting.\n\nBest Wishes\n\nPhillip\n"},{"id":"377352","messageId":"991b0908-4ec5-2d19-4df3-df3eb28632c2@gmail.com","threadId":"51325","inReplyTo":"xmqq36k9tb30.fsf@gitster-ct.c.googlers.com","subject":"Re: [PATCH] show --continue/skip etc. consistently in synopsis","fromName":"Phillip Wood","fromEmail":"phillip.wood123@gmail.com","sentAt":"2019-06-17T09:15:25Z","receivedAt":"2019-06-17T09:15:19Z","isPatch":true,"sender":{"key":"phillip.wood@dunelm.org.uk","avatar":null},"body":"On 16/06/2019 23:33, Junio C Hamano wrote:\n> Phillip Wood <phillip.wood123@gmail.com> writes:\n> \n>> From: Phillip Wood <phillip.wood@dunelm.org.uk>\n>>\n>> The synopsis for am shows the command mode options as\n>>     (--continue | --skip | --abort | --quit)\n>> They are on a single line and in parenthesis as they are not\n>> optional. Fix the merge and rebase docs to match this style.\n> \n> Is it so clear-cut that it is more \"correct\" to have everything on a\n> single line, as opposed to describing each one per line?  I am not\n> sure.\n\nI'm not sure I'd argue too hard one way or the other, but I do think the\ndocumentation for the various commands should try to be consistent and\nthe am, cherry-pick, rebase and revert man pages all use a single line\nfor these options (although rebase is missing the parentheses).\n\nI'll re-roll with Elijah's correction and a sign off\n\nBest Wishes\n\nPhillip\n\n> \n> I would say both the above style and the style used by \"git merge\"\n> documentation are correct.  The \"rebase\" one is a different story\n> and the change in this patch deserves to be called a \"fix\".\n> \n> As long as the more concise \"am\" style is already prevalent (are\n> there pages other than \"am\" you can cite?), I would agree with you\n> that the change to \"git merge\" in this patch is a good idea for\n> consistency's sake.\n> \n>> ---\n>> This patch is based on top of nd/merge-quit.\n> \n> Thanks for indicating where it should go.  We need your sign-off,\n> too.>\n> \n> \n>> The docs for cherry-pick/revert are updated to this style by\n>> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u\n>>\n>> Documentation/git-merge.txt  | 3 +--\n>>  Documentation/git-rebase.txt | 2 +-\n>>  2 files changed, 2 insertions(+), 3 deletions(-)\n>>\n>> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\n>> index b7d581fc76..07ca9fb78c 100644\n>> --- a/Documentation/git-merge.txt\n>> +++ b/Documentation/git-merge.txt\n>> @@ -13,8 +13,7 @@ SYNOPSIS\n>>  \t[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]\n>>  \t[--[no-]allow-unrelated-histories]\n>>  \t[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]\n>> -'git merge' --abort\n>> -'git merge' --continue\n>> +'git merge' (--continue | --skip | --abort | --quit)\n>>  \n>>  DESCRIPTION\n>>  -----------\n>> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\n>> index 5629ba4c5d..a67d40596a 100644\n>> --- a/Documentation/git-rebase.txt\n>> +++ b/Documentation/git-rebase.txt\n>> @@ -12,7 +12,7 @@ SYNOPSIS\n>>  \t[<upstream> [<branch>]]\n>>  'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]\n>>  \t--root [<branch>]\n>> -'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch\n>> +'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)\n>>  \n>>  DESCRIPTION\n>>  -----------\n\n"},{"id":"377353","messageId":"20190617091709.5785-1-phillip.wood123@gmail.com","threadId":"51325","inReplyTo":"20190616132457.19413-1-phillip.wood123@gmail.com","subject":"[PATCH v2] show --continue/skip etc. consistently in synopsis","fromName":"Phillip Wood","fromEmail":"phillip.wood123@gmail.com","sentAt":"2019-06-17T09:17:09Z","receivedAt":"2019-06-17T09:17:13Z","isPatch":true,"sender":{"key":"phillip.wood@dunelm.org.uk","avatar":null},"body":"From: Phillip Wood <phillip.wood@dunelm.org.uk>\n\nThe synopsis for am shows the command mode options as\n    (--continue | --skip | --abort | --quit)\nThey are on a single line and in parenthesis as they are not\noptional. Fix the merge and rebase docs to match this style.\n\nSigned-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>\n---\n\nNotes:\n    This patch is based on top of nd/merge-quit.\n    The docs for cherry-pick/revert are updated to this style by\n    https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u\n\n Documentation/git-merge.txt  | 3 +--\n Documentation/git-rebase.txt | 2 +-\n 2 files changed, 2 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\nindex b7d581fc76..926ea4f460 100644\n--- a/Documentation/git-merge.txt\n+++ b/Documentation/git-merge.txt\n@@ -13,8 +13,7 @@ SYNOPSIS\n \t[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]\n \t[--[no-]allow-unrelated-histories]\n \t[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]\n-'git merge' --abort\n-'git merge' --continue\n+'git merge' (--continue | --abort | --quit)\n \n DESCRIPTION\n -----------\ndiff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\nindex 5629ba4c5d..a67d40596a 100644\n--- a/Documentation/git-rebase.txt\n+++ b/Documentation/git-rebase.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n \t[<upstream> [<branch>]]\n 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]\n \t--root [<branch>]\n-'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch\n+'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)\n \n DESCRIPTION\n -----------\n-- \n2.21.0\n\n"},{"id":"377376","messageId":"xmqqfto7suvf.fsf@gitster-ct.c.googlers.com","threadId":"51325","inReplyTo":"991b0908-4ec5-2d19-4df3-df3eb28632c2@gmail.com","subject":"Re: [PATCH] show --continue/skip etc. consistently in synopsis","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-06-17T22:35:32Z","receivedAt":"2019-06-17T22:35:37Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Phillip Wood <phillip.wood123@gmail.com> writes:\n\n> I'm not sure I'd argue too hard one way or the other, but I do think the\n> documentation for the various commands should try to be consistent and\n> the am, cherry-pick, rebase and revert man pages all use a single line\n> for these options (although rebase is missing the parentheses).\n\nGood.  Then please write these names in the proposed log message;\nthe version I commented on looked a bit strange to single out \"am\",\nas if we are siding on a minority, but writing the names of its\nfriends that share the convention would not give that wrong\nimpression to the readers.\n\nThanks.\n"}]}