From: Junio C Hamano <gitster@pobox.com>
To: Phillip Wood <phillip.wood123@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>,
Phillip Wood <phillip.wood@dunelm.org.uk>
Subject: Re: [PATCH] show --continue/skip etc. consistently in synopsis
Date: Sun, 16 Jun 2019 15:33:07 -0700 [thread overview]
Message-ID: <xmqq36k9tb30.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20190616132457.19413-1-phillip.wood123@gmail.com> (Phillip Wood's message of "Sun, 16 Jun 2019 14:24:57 +0100")
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
> -----------
next prev parent reply other threads:[~2019-06-16 22:33 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-16 13:24 [PATCH] show --continue/skip etc. consistently in synopsis Phillip Wood
2019-06-16 22:33 ` Junio C Hamano [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq36k9tb30.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=phillip.wood123@gmail.com \
--cc=phillip.wood@dunelm.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).