From: Christian Couder <christian.couder@gmail.com>
To: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Cc: git <git@vger.kernel.org>,
"Shourya Shukla" <shouryashukla.oo@gmail.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"Christian Couder" <chriscool@tuxfamily.org>,
"Đoàn Trần Công Danh" <congdanhqx@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Denton Liu" <liu.denton@gmail.com>,
"Eric Sunshine" <sunshine@sunshineco.com>
Subject: Re: [GSoC][PATCH v5] submodule: port subcommand 'set-branch' from shell to C
Date: Tue, 2 Jun 2020 21:45:39 +0200 [thread overview]
Message-ID: <CAP8UFD3Qe3iDe+ymKsqv9HarFLYDohXmUGbkNwZ4MdVQ=XP7yQ@mail.gmail.com> (raw)
In-Reply-To: <1b851e49-3bb1-3b59-7f24-b903c5514391@gmail.com>
On Tue, Jun 2, 2020 at 9:01 PM Kaartic Sivaraam
<kaartic.sivaraam@gmail.com> wrote:
>
> On 02-06-2020 22:05, Shourya Shukla wrote:
> > Convert submodule subcommand 'set-branch' to a builtin and call it via
> > 'git-submodule.sh'.
> >
> > Mentored-by: Christian Couder <chriscool@tuxfamily.org>
> > Mentored-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
> > Helped-by: Denton Liu <liu.denton@gmail.com>
> > Helped-by: Eric Sunshine <sunshine@sunshineco.com>
> > Helped-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
> > Signed-off-by: Shourya Shukla <shouryashukla.oo@gmail.com>
> > ---
> > Here is the v5 of the subcommand. Thank you Danh for the feedback! I
> > apologise for not replying on time. I have taken into account Danh's
> > suggestions on the `quiet` option as well as done the fixup Dscho
> > suggested (fixed by Junio here:
> > https://github.com/gitster/git/commit/77ba62f66ff8e3de54d81c240542edb42a2711c7)
> >
> > builtin/submodule--helper.c | 44 +++++++++++++++++++++++++++++++++++++
> > git-submodule.sh | 32 +++------------------------
> > 2 files changed, 47 insertions(+), 29 deletions(-)
> >
> > diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
> > index f50745a03f..a974e17571 100644
> > --- a/builtin/submodule--helper.c
> > +++ b/builtin/submodule--helper.c
> > @@ -2284,6 +2284,49 @@ static int module_set_url(int argc, const char **argv, const char *prefix)
> > return 0;
> > }
> >
> > +static int module_set_branch(int argc, const char **argv, const char *prefix)
> > +{
> > + int opt_default = 0, ret;
> > + const char *opt_branch = NULL;
> > + const char *path;
> > + char *config_name;
> > +
> > + /*
> > + * We accept the `quiet` option for uniformity across subcommands,
> > + * though there is nothing to make less verbose in this subcommand.
> > + */
> > + struct option options[] = {
> > + OPT_NOOP_NOARG('q', "quiet"),
> > + OPT_BOOL('d', "default", &opt_default,
> > + N_("set the default tracking branch to master")),
> > + OPT_STRING('b', "branch", &opt_branch, N_("branch"),
> > + N_("set the default tracking branch")),
> > + OPT_END()
> > + };
> > + const char *const usage[] = {
> > + N_("git submodule--helper set-branch [-q|--quiet] (-d|--default) <path>"),
> > + N_("git submodule--helper set-branch [-q|--quiet] (-b|--branch) <branch> <path>"),
> > + NULL
> > + };
>
> I'm having second thoughts about my suggestion[1] to include
> the short option for '--quiet' in the usage. This is the only
> usage in submodule--helper that mentions that '-q' is a short
> hand for '--quiet'. That seems inconsistent. I see two ways but
> I'm not sure which one of these would be better:
>
> A. Dropping the mention of '-q' in this usage thus making it consistent
> with the other usages printed by submodule--helper.
>
> B. Fixing other usages of submodule--helper to mention that '-q' is
> shorthand for quiet. This has the benefit of properly advertising
> the shorthand.
>
> C. Just ignore this?
The `git submodule` documentation has:
-q::
--quiet::
Only print error messages.
even though the Synopsis is:
'git submodule' [--quiet] [--cached]
'git submodule' [--quiet] add [<options>] [--] <repository> [<path>]
'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
...
So I prefer B, and maybe updating the synopsis, as I think most Git
commands have '-q' meaning '--quiet'.
[...]
> So, according to this, I think the usage should be ...
>
> git submodule--helper set-branch [-q | --quiet] [-d | --default] <path>
>
> ... and ...
>
> git submodule--helper set-branch [-q|--quiet] [-b | --branch]<branch> <path>
>
> ... respectively.
I don't agree. I think `git submodule--helper set-branch ...` requires
either "-d | --default" or "-b | --branch", while for example:
git submodule--helper set-branch [-q | --quiet] [-d | --default] <path>
would mean that "git submodule--helper set-branch my/path" is valid.
next prev parent reply other threads:[~2020-06-02 19:46 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-21 16:38 [PATCH v3] submodule: port subcommand 'set-branch' from shell to C Shourya Shukla
2020-05-21 18:44 ` Junio C Hamano
2020-05-21 19:03 ` Denton Liu
2020-05-21 19:50 ` Junio C Hamano
2020-05-22 19:39 ` Shourya Shukla
2020-05-24 16:07 ` Junio C Hamano
2020-05-21 23:04 ` Đoàn Trần Công Danh
2020-05-22 22:21 ` Johannes Schindelin
2020-05-24 23:15 ` Junio C Hamano
2020-05-24 23:18 ` Junio C Hamano
2020-05-23 16:39 ` [PATCH v4] " Shourya Shukla
2020-05-23 18:49 ` Kaartic Sivaraam
2020-05-23 23:18 ` Đoàn Trần Công Danh
2020-05-27 17:13 ` Shourya Shukla
2020-05-28 12:21 ` Đoàn Trần Công Danh
2020-05-28 14:01 ` Đoàn Trần Công Danh
2020-05-28 15:55 ` Đoàn Trần Công Danh
2020-06-02 16:35 ` [GSoC][PATCH v5] " Shourya Shukla
2020-06-02 17:58 ` Junio C Hamano
2020-06-03 0:12 ` Đoàn Trần Công Danh
2020-06-03 20:02 ` Junio C Hamano
2020-06-04 7:17 ` Shourya Shukla
2020-06-04 7:49 ` Christian Couder
2020-06-04 15:03 ` Junio C Hamano
2020-06-02 19:01 ` Kaartic Sivaraam
2020-06-02 19:10 ` Kaartic Sivaraam
2020-06-02 19:45 ` Christian Couder [this message]
2020-06-04 7:09 ` Shourya Shukla
2020-06-04 19:26 ` Kaartic Sivaraam
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='CAP8UFD3Qe3iDe+ymKsqv9HarFLYDohXmUGbkNwZ4MdVQ=XP7yQ@mail.gmail.com' \
--to=christian.couder@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=chriscool@tuxfamily.org \
--cc=congdanhqx@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=kaartic.sivaraam@gmail.com \
--cc=liu.denton@gmail.com \
--cc=shouryashukla.oo@gmail.com \
--cc=sunshine@sunshineco.com \
/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).