git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: William Pursell <william.r.pursell@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH] doc: git-describe
Date: Tue, 14 Aug 2018 06:58:53 -0600	[thread overview]
Message-ID: <CAJPQ5NaYn=rMb2j1KxEk8518Z3vD+-uEOamuu1QWacgnzNtKWQ@mail.gmail.com> (raw)

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

             reply	other threads:[~2018-08-14 12:59 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-14 12:58 William Pursell [this message]
2018-08-14 16:14 ` [PATCH] doc: git-describe Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAJPQ5NaYn=rMb2j1KxEk8518Z3vD+-uEOamuu1QWacgnzNtKWQ@mail.gmail.com' \
    --to=william.r.pursell@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).