[PATCH] doc: git-describe

From

William Pursell <william.r.pursell@gmail.com>

Date

Aug 14, 2018, 12:58 UTC

Message-ID

<CAJPQ5NaYn=rMb2j1KxEk8518Z3vD+-uEOamuu1QWacgnzNtKWQ@mail.gmail.com>

commit cc4bd5268b2dbe90279198acb400a528ee23f5d5
Author: William Pursell <williamp@wepay.com>
Date:   Tue Aug 14 06:41:00 2018 -0600

    doc: Reference <mark> for --dirty/--broken

diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index e027fb8c4b..f7d67306c0 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -39,11 +39,12 @@ OPTIONS
 --broken[=<mark>]::
  Describe the state of the working tree.  When the working
  tree matches HEAD, the output is the same as "git describe
- HEAD".  If the working tree has local modification "-dirty"
- is appended to it.  If a repository is corrupt and Git
- cannot determine if there is local modification, Git will
- error out, unless `--broken' is given, which appends
- the suffix "-broken" instead.
+ HEAD".  If the working tree has local modification, "-dirty"
+ (or <mark>, if supplied) is appended to it.  If a repository
+ is corrupt and Git cannot determine if there is local
+ modification, Git will error out unless `--broken' is given
+ in which case it will append the suffix "-broken" (or <mark>,
+ if supplied) instead.

 --all::
  Instead of using only the annotated tags, use any ref