From: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
To: Git Users <git@vger.kernel.org>
Cc: Shourya Shukla <shouryashukla.oo@gmail.com>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Christian Couder <chriscool@tuxfamily.org>,
Christian Couder <christian.couder@gmail.com>,
congdanhqx@gmail.com, Junio C Hamano <gitster@pobox.com>,
liu.denton@gmail.com, Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [GSoC][PATCH v5] submodule: port subcommand 'set-branch' from shell to C
Date: Wed, 3 Jun 2020 00:40:58 +0530 [thread overview]
Message-ID: <CA+ARAtoDzoU=eu0mJom7LwVF60k4CtiuBha-RC7zkx9o7O=H3A@mail.gmail.com> (raw)
In-Reply-To: <1b851e49-3bb1-3b59-7f24-b903c5514391@gmail.com>
On Wed, Jun 3, 2020 at 12:31 AM Kaartic Sivaraam
<kaartic.sivaraam@gmail.com> wrote:
>
> I also noticed one other thing. A quote from
> Documentation/CodingGuidelines regarding the usage for reference:
>
> > Optional parts are enclosed in square brackets:
> > [<extra>]
> > (Zero or one <extra>.)
> >
> > --exec-path[=<path>]
> > (Option with an optional argument. Note that the "=" is inside the
> > brackets.)
> >
> > [<patch>...]
> > (Zero or more of <patch>. Note that the dots are inside, not
> > outside the brackets.)
> >
> > Multiple alternatives are indicated with vertical bars:
> > [-q | --quiet]
> > [--utf8 | --no-utf8]
> >
> > Parentheses are used for grouping:
> > [(<rev> | <range>)...]
> > (Any number of either <rev> or <range>. Parens are needed to make
> > it clear that "..." pertains to both <rev> and <range>.)
> >
> > [(-p <parent>)...]
> > (Any number of option -p, each with one <parent> argument.)
> >
> > git remote set-head <name> (-a | -d | <branch>)
> > (One and only one of "-a", "-d" or "<branch>" _must_ (no square
> > brackets) be provided.)
>
> 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>
>
Apologies, my mail client messed a little with the formatting.
This should actually be:
git submodule--helper set-branch [-q | --quiet] [-b | --branch]
<branch> <path>
> ... respectively.
>
> > + NULL
> > + };
>
> ---
> Footnotes:
>
> [1]:
> https://github.com/periperidip/git/commit/9a8918bf0688c583740b3dddafdba82f47972442#r39606384
>
--
Sivaraam
next prev parent reply other threads:[~2020-06-02 19:13 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 [this message]
2020-06-02 19:45 ` Christian Couder
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='CA+ARAtoDzoU=eu0mJom7LwVF60k4CtiuBha-RC7zkx9o7O=H3A@mail.gmail.com' \
--to=kaartic.sivaraam@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=chriscool@tuxfamily.org \
--cc=christian.couder@gmail.com \
--cc=congdanhqx@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).