Merge branch 'maint-1.5.4' into maint

[git.git] / Documentation / git-rev-parse.txt

diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index af988821b81ee03fecb02ce038a16ca49220009c..6513c2efe17668d5fc25a21385ed117ec76b40b5 100644 (file)
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -234,8 +234,8 @@ blobs contained in a commit.
   (typically the current branch), and stage 3 is the version from
   the branch being merged.
 
   (typically the current branch), and stage 3 is the version from
   the branch being merged.
 

-Here is an illustration, by Jon Loeliger.  Both node B and C are
-commit parents of commit node A.  Parent commits are ordered
+Here is an illustration, by Jon Loeliger.  Both commit nodes B
+and C are parents of commit node A.  Parent commits are ordered

 left-to-right.
 
     G   H   I   J
 left-to-right.
 
     G   H   I   J


@@ -325,7 +325,7 @@ The lines after the separator describe the options.
 Each line of options has this format:
 
 ------------
 Each line of options has this format:
 
 ------------

-<opt_spec><arg_spec>? SP+ help LF
+<opt_spec><flags>* SP+ help LF

 ------------
 
 `<opt_spec>`::
 ------------
 
 `<opt_spec>`::


@@ -334,10 +334,17 @@ Each line of options has this format:
        is necessary. `h,help`, `dry-run` and `f` are all three correct
        `<opt_spec>`.
 
        is necessary. `h,help`, `dry-run` and `f` are all three correct
        `<opt_spec>`.
 

-`<arg_spec>`::
-       an `<arg_spec>` tells the option parser if the option has an argument
-       (`=`), an optional one (`?` though its use is discouraged) or none
-       (no `<arg_spec>` in that case).
+`<flags>`::
+       `<flags>` are of `*`, `=`, `?` or `!`.
+       * Use `=` if the option takes an argument.
+
+       * Use `?` to mean that the option is optional (though its use is discouraged).
+
+       * Use `*` to mean that this option should not be listed in the usage
+         generated for the `-h` argument. It's shown for `--help-all` as
+         documented in linkgit:gitcli[5].
+
+       * Use `!` to not make the corresponding negated long option available.

 
 The remainder of the line, after stripping the spaces, is used
 as the help associated to the option.
 
 The remainder of the line, after stripping the spaces, is used
 as the help associated to the option.