* [PATCH] show --continue/skip etc. consistently in synopsis
@ 2019-06-16 13:24 Phillip Wood
2019-06-16 22:33 ` Junio C Hamano
` (2 more replies)
0 siblings, 3 replies; 7+ messages in thread
From: Phillip Wood @ 2019-06-16 13:24 UTC (permalink / raw)
To: Git Mailing List; +Cc: Phillip Wood
From: Phillip Wood <phillip.wood@dunelm.org.uk>
The synopsis for am shows the command mode options as
(--continue | --skip | --abort | --quit)
They are on a single line and in parenthesis as they are not
optional. Fix the merge and rebase docs to match this style.
---
This patch is based on top of nd/merge-quit.
The docs for cherry-pick/revert are updated to this style by
https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u
Documentation/git-merge.txt | 3 +--
Documentation/git-rebase.txt | 2 +-
2 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index b7d581fc76..07ca9fb78c 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -13,8 +13,7 @@ SYNOPSIS
[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
[--[no-]allow-unrelated-histories]
[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
-'git merge' --abort
-'git merge' --continue
+'git merge' (--continue | --skip | --abort | --quit)
DESCRIPTION
-----------
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 5629ba4c5d..a67d40596a 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -12,7 +12,7 @@ SYNOPSIS
[<upstream> [<branch>]]
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
--root [<branch>]
-'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
+'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
DESCRIPTION
-----------
--
2.22.0
^ permalink raw reply related [flat|nested] 7+ messages in thread* Re: [PATCH] show --continue/skip etc. consistently in synopsis
2019-06-16 13:24 [PATCH] show --continue/skip etc. consistently in synopsis Phillip Wood
@ 2019-06-16 22:33 ` Junio C Hamano
2019-06-17 9:15 ` Phillip Wood
2019-06-17 2:02 ` Elijah Newren
2019-06-17 9:17 ` [PATCH v2] " Phillip Wood
2 siblings, 1 reply; 7+ messages in thread
From: Junio C Hamano @ 2019-06-16 22:33 UTC (permalink / raw)
To: Phillip Wood; +Cc: Git Mailing List, Phillip Wood
Phillip Wood <phillip.wood123@gmail.com> writes:
> From: Phillip Wood <phillip.wood@dunelm.org.uk>
>
> The synopsis for am shows the command mode options as
> (--continue | --skip | --abort | --quit)
> They are on a single line and in parenthesis as they are not
> optional. Fix the merge and rebase docs to match this style.
Is it so clear-cut that it is more "correct" to have everything on a
single line, as opposed to describing each one per line? I am not
sure.
I would say both the above style and the style used by "git merge"
documentation are correct. The "rebase" one is a different story
and the change in this patch deserves to be called a "fix".
As long as the more concise "am" style is already prevalent (are
there pages other than "am" you can cite?), I would agree with you
that the change to "git merge" in this patch is a good idea for
consistency's sake.
> ---
> This patch is based on top of nd/merge-quit.
Thanks for indicating where it should go. We need your sign-off,
too.
> The docs for cherry-pick/revert are updated to this style by
> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u
>
> Documentation/git-merge.txt | 3 +--
> Documentation/git-rebase.txt | 2 +-
> 2 files changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
> index b7d581fc76..07ca9fb78c 100644
> --- a/Documentation/git-merge.txt
> +++ b/Documentation/git-merge.txt
> @@ -13,8 +13,7 @@ SYNOPSIS
> [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
> [--[no-]allow-unrelated-histories]
> [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
> -'git merge' --abort
> -'git merge' --continue
> +'git merge' (--continue | --skip | --abort | --quit)
>
> DESCRIPTION
> -----------
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 5629ba4c5d..a67d40596a 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -12,7 +12,7 @@ SYNOPSIS
> [<upstream> [<branch>]]
> 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
> --root [<branch>]
> -'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
> +'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
>
> DESCRIPTION
> -----------
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] show --continue/skip etc. consistently in synopsis
2019-06-16 22:33 ` Junio C Hamano
@ 2019-06-17 9:15 ` Phillip Wood
2019-06-17 22:35 ` Junio C Hamano
0 siblings, 1 reply; 7+ messages in thread
From: Phillip Wood @ 2019-06-17 9:15 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Git Mailing List, Phillip Wood
On 16/06/2019 23:33, Junio C Hamano wrote:
> Phillip Wood <phillip.wood123@gmail.com> writes:
>
>> From: Phillip Wood <phillip.wood@dunelm.org.uk>
>>
>> The synopsis for am shows the command mode options as
>> (--continue | --skip | --abort | --quit)
>> They are on a single line and in parenthesis as they are not
>> optional. Fix the merge and rebase docs to match this style.
>
> Is it so clear-cut that it is more "correct" to have everything on a
> single line, as opposed to describing each one per line? I am not
> sure.
I'm not sure I'd argue too hard one way or the other, but I do think the
documentation for the various commands should try to be consistent and
the am, cherry-pick, rebase and revert man pages all use a single line
for these options (although rebase is missing the parentheses).
I'll re-roll with Elijah's correction and a sign off
Best Wishes
Phillip
>
> I would say both the above style and the style used by "git merge"
> documentation are correct. The "rebase" one is a different story
> and the change in this patch deserves to be called a "fix".
>
> As long as the more concise "am" style is already prevalent (are
> there pages other than "am" you can cite?), I would agree with you
> that the change to "git merge" in this patch is a good idea for
> consistency's sake.
>
>> ---
>> This patch is based on top of nd/merge-quit.
>
> Thanks for indicating where it should go. We need your sign-off,
> too.>
>
>
>> The docs for cherry-pick/revert are updated to this style by
>> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u
>>
>> Documentation/git-merge.txt | 3 +--
>> Documentation/git-rebase.txt | 2 +-
>> 2 files changed, 2 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
>> index b7d581fc76..07ca9fb78c 100644
>> --- a/Documentation/git-merge.txt
>> +++ b/Documentation/git-merge.txt
>> @@ -13,8 +13,7 @@ SYNOPSIS
>> [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
>> [--[no-]allow-unrelated-histories]
>> [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
>> -'git merge' --abort
>> -'git merge' --continue
>> +'git merge' (--continue | --skip | --abort | --quit)
>>
>> DESCRIPTION
>> -----------
>> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
>> index 5629ba4c5d..a67d40596a 100644
>> --- a/Documentation/git-rebase.txt
>> +++ b/Documentation/git-rebase.txt
>> @@ -12,7 +12,7 @@ SYNOPSIS
>> [<upstream> [<branch>]]
>> 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
>> --root [<branch>]
>> -'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
>> +'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
>>
>> DESCRIPTION
>> -----------
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] show --continue/skip etc. consistently in synopsis
2019-06-17 9:15 ` Phillip Wood
@ 2019-06-17 22:35 ` Junio C Hamano
0 siblings, 0 replies; 7+ messages in thread
From: Junio C Hamano @ 2019-06-17 22:35 UTC (permalink / raw)
To: Phillip Wood; +Cc: Git Mailing List, Phillip Wood
Phillip Wood <phillip.wood123@gmail.com> writes:
> I'm not sure I'd argue too hard one way or the other, but I do think the
> documentation for the various commands should try to be consistent and
> the am, cherry-pick, rebase and revert man pages all use a single line
> for these options (although rebase is missing the parentheses).
Good. Then please write these names in the proposed log message;
the version I commented on looked a bit strange to single out "am",
as if we are siding on a minority, but writing the names of its
friends that share the convention would not give that wrong
impression to the readers.
Thanks.
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] show --continue/skip etc. consistently in synopsis
2019-06-16 13:24 [PATCH] show --continue/skip etc. consistently in synopsis Phillip Wood
2019-06-16 22:33 ` Junio C Hamano
@ 2019-06-17 2:02 ` Elijah Newren
2019-06-17 9:11 ` Phillip Wood
2019-06-17 9:17 ` [PATCH v2] " Phillip Wood
2 siblings, 1 reply; 7+ messages in thread
From: Elijah Newren @ 2019-06-17 2:02 UTC (permalink / raw)
To: Phillip Wood; +Cc: Git Mailing List
On Sun, Jun 16, 2019 at 6:29 AM Phillip Wood <phillip.wood123@gmail.com> wrote:
>
> From: Phillip Wood <phillip.wood@dunelm.org.uk>
>
> The synopsis for am shows the command mode options as
> (--continue | --skip | --abort | --quit)
> They are on a single line and in parenthesis as they are not
> optional. Fix the merge and rebase docs to match this style.
Thanks for working to make this more consistent. One minor issue...
> ---
> This patch is based on top of nd/merge-quit.
> The docs for cherry-pick/revert are updated to this style by
> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u
>
> Documentation/git-merge.txt | 3 +--
> Documentation/git-rebase.txt | 2 +-
> 2 files changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
> index b7d581fc76..07ca9fb78c 100644
> --- a/Documentation/git-merge.txt
> +++ b/Documentation/git-merge.txt
> @@ -13,8 +13,7 @@ SYNOPSIS
> [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
> [--[no-]allow-unrelated-histories]
> [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
> -'git merge' --abort
> -'git merge' --continue
> +'git merge' (--continue | --skip | --abort | --quit)
merge --skip? I think you meant to just add --quit here, but copied
from elsewhere and accidentally inserted --skip?
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] show --continue/skip etc. consistently in synopsis
2019-06-17 2:02 ` Elijah Newren
@ 2019-06-17 9:11 ` Phillip Wood
0 siblings, 0 replies; 7+ messages in thread
From: Phillip Wood @ 2019-06-17 9:11 UTC (permalink / raw)
To: Elijah Newren, Phillip Wood; +Cc: Git Mailing List
On 17/06/2019 03:02, Elijah Newren wrote:
> On Sun, Jun 16, 2019 at 6:29 AM Phillip Wood <phillip.wood123@gmail.com> wrote:
>>
>> From: Phillip Wood <phillip.wood@dunelm.org.uk>
>>
>> The synopsis for am shows the command mode options as
>> (--continue | --skip | --abort | --quit)
>> They are on a single line and in parenthesis as they are not
>> optional. Fix the merge and rebase docs to match this style.
>
> Thanks for working to make this more consistent. One minor issue...
>
>> ---
>> This patch is based on top of nd/merge-quit.
>> The docs for cherry-pick/revert are updated to this style by
>> https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u
>>
>> Documentation/git-merge.txt | 3 +--
>> Documentation/git-rebase.txt | 2 +-
>> 2 files changed, 2 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
>> index b7d581fc76..07ca9fb78c 100644
>> --- a/Documentation/git-merge.txt
>> +++ b/Documentation/git-merge.txt
>> @@ -13,8 +13,7 @@ SYNOPSIS
>> [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
>> [--[no-]allow-unrelated-histories]
>> [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
>> -'git merge' --abort
>> -'git merge' --continue
>> +'git merge' (--continue | --skip | --abort | --quit)
>
> merge --skip? I think you meant to just add --quit here, but copied
> from elsewhere and accidentally inserted --skip?
Thanks, you're right I got a bit carried away with copying and pasting.
Best Wishes
Phillip
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH v2] show --continue/skip etc. consistently in synopsis
2019-06-16 13:24 [PATCH] show --continue/skip etc. consistently in synopsis Phillip Wood
2019-06-16 22:33 ` Junio C Hamano
2019-06-17 2:02 ` Elijah Newren
@ 2019-06-17 9:17 ` Phillip Wood
2 siblings, 0 replies; 7+ messages in thread
From: Phillip Wood @ 2019-06-17 9:17 UTC (permalink / raw)
To: Junio C Hamano, Elijah Newren, Git Mailing List; +Cc: Phillip Wood
From: Phillip Wood <phillip.wood@dunelm.org.uk>
The synopsis for am shows the command mode options as
(--continue | --skip | --abort | --quit)
They are on a single line and in parenthesis as they are not
optional. Fix the merge and rebase docs to match this style.
Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
---
Notes:
This patch is based on top of nd/merge-quit.
The docs for cherry-pick/revert are updated to this style by
https://public-inbox.org/git/20190616082040.9440-1-rohit.ashiwal265@gmail.com/T/#u
Documentation/git-merge.txt | 3 +--
Documentation/git-rebase.txt | 2 +-
2 files changed, 2 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index b7d581fc76..926ea4f460 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -13,8 +13,7 @@ SYNOPSIS
[-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
[--[no-]allow-unrelated-histories]
[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
-'git merge' --abort
-'git merge' --continue
+'git merge' (--continue | --abort | --quit)
DESCRIPTION
-----------
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 5629ba4c5d..a67d40596a 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -12,7 +12,7 @@ SYNOPSIS
[<upstream> [<branch>]]
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
--root [<branch>]
-'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch
+'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
DESCRIPTION
-----------
--
2.21.0
^ permalink raw reply related [flat|nested] 7+ messages in thread
end of thread, other threads:[~2019-06-17 22:35 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-06-16 13:24 [PATCH] show --continue/skip etc. consistently in synopsis Phillip Wood
2019-06-16 22:33 ` Junio C Hamano
2019-06-17 9:15 ` Phillip Wood
2019-06-17 22:35 ` Junio C Hamano
2019-06-17 2:02 ` Elijah Newren
2019-06-17 9:11 ` Phillip Wood
2019-06-17 9:17 ` [PATCH v2] " Phillip Wood
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).