From: Jeff King <peff@peff.net>
Date: Sun, 08 Jun 2008 04:23:56 GMT
Subject: Re: [PATCH v2] git-commit.txt: Correct option alternatives
Message-ID: <20080608042356.GA11194@sigill.intra.peff.net>
In-Reply-To: <484B37B6.1040408@freescale.com>

On Sat, Jun 07, 2008 at 08:36:54PM -0500, Jon Loeliger wrote:

>> Furthermore, for long-option consistency --author <author>
>> is changed to --author=<author>.
> Say, if we were to document and espouse one form over the other,
> which would you recommend or prefer?

$ sed -ne '/sticked/,/^$/p' Documentation/gitcli.txt
 * when a command line option takes an argument, use the 'sticked' 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 'sticked' form.

'sticked' form must be used:
----------------------------
$ git describe --abbrev HEAD     # correct
$ git describe --abbrev=10 HEAD  # correct
$ git describe --abbrev 10 HEAD  # NOT WHAT YOU MEANT
----------------------------

-Peff