Re: [PATCH v4] submodule: port subcommand 'set-branch' from shell to C
- From
Đoàn Trần Công Danh <congdanhqx@gmail.com>
- Date
- May 28, 2020, 15:55 UTC
- Message-ID
- <20200528155522.GA16787@danh.dev>
- In-Reply-To
- <20200528140142.GA1951@danh.dev>
On 2020-05-28 21:01:42+0700, Đoàn Trần Công Danh <congdanhqx@gmail.com> wrote:
Show 47 quoted lines
> On 2020-05-28 19:21:47+0700, Đoàn Trần Công Danh <congdanhqx@gmail.com> wrote:
> > On 2020-05-27 22:43:58+0530, Shourya Shukla <shouryashukla.oo@gmail.com> wrote:
> > > > + git ${wt_prefix:+-C "$wt_prefix"} ${prefix:+--super-prefix "$prefix"} submodule--helper set-branch ${GIT_QUIET:+--quiet} ${branch:+--branch $branch} ${default:+--default} -- "$@"
> > >
> > > > Danh questioned whether '$branch' needs to be quoted here. I too think it
> > > > needs to be quoted unless I'm missing something.
> > >
> > > We want to do this because $branch is an argument right?
> >
> > We want to do this because we don't want to whitespace-split "$branch"
> >
> > Let's say, for some reason, this command was run:
> >
> > git submodule set-branch --branch "a-branch --branch another" a-submodule
>
> Anyway, after typing this.
> I'm thinking a bit, then re-read gitcli(7),
> I think git-submodule is quite broken regarding to Git's guidelines:
>
> -----------8<----------
>
> Here are the rules regarding the "flags" that you should follow when you are
> scripting Git:
>
> * it's preferred to use the non-dashed form of Git commands, which means that
> you should prefer `git foo` to `git-foo`.
>
> * splitting short options to separate words (prefer `git foo -a -b`
> to `git foo -ab`, the latter may not even work).
>
> * when a command-line option takes an argument, use the 'stuck' form. In
> other words, write `git foo -oArg` instead of `git foo -o Arg` for short
> options, and `git foo --long-opt=Arg` instead of `git foo --long-opt Arg`
> for long options. An option that takes optional option-argument must be
> written in the 'stuck' form.
> ------------>8--------------
>
> Current Git, with and without this change, this command will fail:
>
> git submodule set-branch --branch=a-branch a-submodule
>
> Thus, a script conformed with gitcli(7) will fail.
> (And our git-submodule(1) doesn't conform with gitcli(7), FWIW).
>
> After this change, those commands will success:
>
> git submodule--helper set-branch --branch a-branch a-submoduleThis should be read:
git submodule--helper set-branch --branch=a-branch a-submodule
Show 17 quoted lines
> git submodule set-branch --branch "a-branch --branch=another" a-submodule > > (The second one was written for demonstration purpose only, > I don't expect it will success) > > This isn't related to this change, and git-submodule(1) will be > rewritten in C in the very near future. > Just want to make sure it's awared. > > > > > This version will run: > > > > git submodule--helper --branch a-branch --branch another a-submodule > > > > Which will success if there's a branch "another" in the "a-submodule". > > While that command should fail because we don't accept refname with > > space.
It's me being noisy again. I'm still puzzled by this idea (and I drank too much coffee, today).
I think the day of conversion of submodule from shell to C finish, we can use current git-submodule--helper as the new git-submodule.
With that idea, I think why don't we passed all arguments from
git submodule set-branch
into git-submodule--helper. (Yes, the idea is wrong because the usage output will have git submodule--helper as $0)
I tried that idea and run the test. To my surprise the test failed :(.
Turn out git-submodule--helper set-branch doesn't do its advertised job, git-submodule--helper set-branch doesn't understand short options -d and -b
We'll need this fixup regardless of the agreement on my other concerns. ----------8<---------
diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c index 305c9abb3b..64636161a7 100644 --- a/builtin/submodule--helper.c +++ b/builtin/submodule--helper.c @@ -2291,9 +2291,9 @@ static int module_set_branch(int argc, const char **argv, const char *prefix) struct option options[] = { OPT__QUIET(&quiet, N_("suppress output for setting default tracking branch")), - OPT_BOOL(0, "default", &opt_default, + OPT_BOOL('d', "default", &opt_default, N_("set the default tracking branch to master")), - OPT_STRING(0, "branch", &opt_branch, N_("branch"), + OPT_STRING('b', "branch", &opt_branch, N_("branch"), N_("set the default tracking branch")), OPT_END() }; ------8<-----------
-- Danh