Code

Merge branch 'maint'
[git.git] / Documentation / git-rev-parse.txt
index 329fce0aab417e5fe02845bd21b693f5200b3634..6513c2efe17668d5fc25a21385ed117ec76b40b5 100644 (file)
@@ -70,6 +70,13 @@ OPTIONS
        possible '{caret}' prefix); this option makes them output in a
        form as close to the original input as possible.
 
        possible '{caret}' prefix); this option makes them output in a
        form as close to the original input as possible.
 
+--symbolic-full-name::
+       This is similar to \--symbolic, but it omits input that
+       are not refs (i.e. branch or tag names; or more
+       explicitly disambiguating "heads/master" form, when you
+       want to name the "master" branch when there is an
+       unfortunately named tag "master"), and show them as full
+       refnames (e.g. "refs/heads/master").
 
 --all::
        Show all refs found in `$GIT_DIR/refs`.
 
 --all::
        Show all refs found in `$GIT_DIR/refs`.
@@ -222,13 +229,13 @@ blobs contained in a commit.
 * A colon, optionally followed by a stage number (0 to 3) and a
   colon, followed by a path; this names a blob object in the
   index at the given path.  Missing stage number (and the colon
 * A colon, optionally followed by a stage number (0 to 3) and a
   colon, followed by a path; this names a blob object in the
   index at the given path.  Missing stage number (and the colon
-  that follows it) names an stage 0 entry. During a merge, stage
+  that follows it) names a stage 0 entry. During a merge, stage
   1 is the common ancestor, stage 2 is the target branch's version
   (typically the current branch), and stage 3 is the version from
   the branch being merged.
 
   1 is the common ancestor, stage 2 is the target branch's version
   (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
-a 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
@@ -284,7 +291,7 @@ and its parent commits exists.  `r1{caret}@` notation means all
 parents of `r1`.  `r1{caret}!` includes commit `r1` but excludes
 its all parents.
 
 parents of `r1`.  `r1{caret}!` includes commit `r1` but excludes
 its all parents.
 
-Here are a handful examples:
+Here are a handful of examples:
 
    D                G H D
    D F              G H I J D F
 
    D                G H D
    D F              G H I J D F
@@ -318,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>`::
@@ -327,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.
@@ -371,4 +385,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite