From: Junio C Hamano <gitster@pobox.com>
Date: Tue, 22 Jul 2014 17:17:34 +0000 (-0700)
Subject: Merge branch 'maint-1.9' into maint
X-Git-Tag: v2.0.3~18
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/bba6acb335e296ed692b4aea224b50fd098f693c?ds=inline;hp=-c

Merge branch 'maint-1.9' into maint

* maint-1.9:
Documentation: fix missing text for rev-parse --verify
---

bba6acb335e296ed692b4aea224b50fd098f693c
diff --combined Documentation/git-rev-parse.txt
index 987395d22a,55ea1a037d..54143a0693
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@@ -102,7 -102,7 +102,7 @@@ eval "set -- $(git rev-parse --sq --pre
  +
  If you want to make sure that the output actually names an object in
  your object database and/or can be used as a specific type of object
- you require, you can add "^{type}" peeling operator to the parameter.
+ you require, you can add "\^{type}" peeling operator to the parameter.
  For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
  names an existing object that is a commit-ish (i.e. a commit, or an
  annotated tag that points at a commit).  To make sure that `$VAR`
@@@ -284,20 -284,20 +284,20 @@@ Input Forma
  
  'git rev-parse --parseopt' input format is fully text based. It has two parts,
  separated by a line that contains only `--`. The lines before the separator
 -(should be more than one) are used for the usage.
 +(should be one or more) are used for the usage.
  The lines after the separator describe the options.
  
  Each line of options has this format:
  
  ------------
 -<opt_spec><flags>* SP+ help LF
 +<opt-spec><flags>*<arg-hint>? SP+ help LF
  ------------
  
 -`<opt_spec>`::
 +`<opt-spec>`::
  	its format is the short option character, then the long option name
  	separated by a comma. Both parts are not required, though at least one
  	is necessary. `h,help`, `dry-run` and `f` are all three correct
 -	`<opt_spec>`.
 +	`<opt-spec>`.
  
  `<flags>`::
  	`<flags>` are of `*`, `=`, `?` or `!`.
@@@ -313,12 -313,6 +313,12 @@@
  
  	* Use `!` to not make the corresponding negated long option available.
  
 +`<arg-hint>`::
 +	`<arg-hint>`, if specified, is used as a name of the argument in the
 +	help output, for options that take arguments. `<arg-hint>` is
 +	terminated by the first whitespace.  It is customary to use a
 +	dash to separate words in a multi-word argument hint.
 +
  The remainder of the line, after stripping the spaces, is used
  as the help associated to the option.
  
@@@ -339,8 -333,6 +339,8 @@@ h,help    show the hel
  
  foo       some nifty option --foo
  bar=      some cool option --bar with an argument
 +baz=arg   another cool option --baz with a named argument
 +qux?path  qux may take a path argument but has meaning by itself
  
    An option group Header
  C?        option C with an optional argument"
@@@ -348,28 -340,6 +348,28 @@@
  eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"
  ------------
  
 +
 +Usage text
 +~~~~~~~~~~
 +
 +When `"$@"` is `-h` or `--help` in the above example, the following
 +usage text would be shown:
 +
 +------------
 +usage: some-command [options] <args>...
 +
 +    some-command does foo and bar!
 +
 +    -h, --help            show the help
 +    --foo                 some nifty option --foo
 +    --bar ...             some cool option --bar with an argument
 +    --baz <arg>           another cool option --baz with a named argument
 +    --qux[=<path>]        qux may take a path argument but has meaning by itself
 +
 +An option group Header
 +    -C[...]               option C with an optional argument
 +------------
 +
  SQ-QUOTE
  --------