From: Thiago Farina <tfransosi@gmail.com>
To: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
Cc: Johannes Sixt <j.sixt@viscovery.net>, git@vger.kernel.org
Subject: Re: [PATCH] Update the usage bundle string.
Date: Thu, 17 Sep 2009 13:16:25 -0300 [thread overview]
Message-ID: <a4c8a6d00909170916u6ba05e36u3b65cc6d9bd726fd@mail.gmail.com> (raw)
In-Reply-To: <vpqbpl9woac.fsf@bauges.imag.fr>
On Thu, Sep 17, 2009 at 1:04 PM, Matthieu Moy
<Matthieu.Moy@grenoble-inp.fr> wrote:
> Johannes Sixt <j.sixt@viscovery.net> writes:
>
>> Thiago Farina schrieb:
>>
>>> +static const char builtin_bundle_usage[] = "\
>>> + git bundle create <file> <git-rev-list args>\n\
>>> + git bundle verify <file>\n\
>>> + git bundle list-heads <file> [refname...]\n\
>>> + git bundle unbundle <file> [refname...]";
>>
>> You indent the usage text. Do other commands do that, too? If you resend,
>> it may be worth using this style:
>>
>> static const char builtin_bundle_usage[] =
>> "git bundle create <file> <git-rev-list args>\n"
>> "git bundle verify <file>\n"
>
> I like aligned usage strings, like:
>
> $ git stash -h
> Usage: git stash list [<options>]
> or: git stash show [<stash>]
> or: git stash drop [-q|--quiet] [<stash>]
> or: git stash ( pop | apply ) [--index] [-q|--quiet] [<stash>]
> or: git stash branch <branchname> [<stash>]
> or: git stash [save [-k|--keep-index] [-q|--quiet] [<message>]]
> or: git stash clear
>
> or
>
> $ git branch -h |& head -n 4
> usage: git branch [options] [-r | -a] [--merged | --no-merged]
> or: git branch [options] [-l] [-f] <branchname> [<start-point>]
> or: git branch [options] [-r] (-d | -D) <branchname>
> or: git branch [options] (-m | -M) [<oldbranch>] <newbranch>
>
I like and prefer this style too. I can use it in my patch, like:
$ git bundle -h
usage: git bundle create <file> <git-rev-list args>
or: git bundle verify <file>
or: git bundle list-heads <file> [refname...]
or: git bundle unbundle <file> [refname...]
instead of:
usage: git bundle create <file> <git-rev-list args>
git bundle verify <file>
git bundle list-heads <file> [refname...]
git bundle unbundle <file> [refname...]
> but Git isn't very consistant here:
>
> $ git bisect -h |& head -n 6
> Usage: git bisect [help|start|bad|good|skip|next|reset|visualize|replay|log|run]
>
> git bisect help
> print this long help message.
> git bisect start [<bad> [<good>...]] [--] [<pathspec>...]
> reset bisect state and start bisection.
>
> --
> Matthieu Moy
> http://www-verimag.imag.fr/~moy/
>
prev parent reply other threads:[~2009-09-17 16:17 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-09-16 21:20 [PATCH] Update the usage bundle string Thiago Farina
2009-09-17 6:12 ` Johannes Sixt
2009-09-17 15:56 ` Thiago Farina
2009-09-17 16:04 ` Matthieu Moy
2009-09-17 16:16 ` Thiago Farina [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a4c8a6d00909170916u6ba05e36u3b65cc6d9bd726fd@mail.gmail.com \
--to=tfransosi@gmail.com \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=j.sixt@viscovery.net \
/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.
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 NNTP newsgroup(s).