On 2020-05-28 19:21:47+0700, Đoàn Trần Công Danh <congdanhqx@xxxxxxxxx> wrote:
> On 2020-05-27 22:43:58+0530, Shourya Shukla <shouryashukla.oo@xxxxxxxxx> 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-submodule
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.
--
Danh
