From: Mark Lodato <lodatom@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Mark Lodato <lodatom@gmail.com>
Subject: [PATCH 8/8] describe docs: note that <commit> is optional
Date: Sat, 18 Dec 2010 00:38:45 -0500 [thread overview]
Message-ID: <1292650725-21149-9-git-send-email-lodatom@gmail.com> (raw)
In-Reply-To: <1292650725-21149-1-git-send-email-lodatom@gmail.com>
Signed-off-by: Mark Lodato <lodatom@gmail.com>
---
Documentation/git-describe.txt | 3 ++-
Documentation/gitcli.txt | 2 +-
builtin/describe.c | 2 +-
3 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index ad173ed..8006d59 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -9,7 +9,7 @@ git-describe - Show the most recent tag that is reachable from a commit
SYNOPSIS
--------
[verse]
-'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] <commit>...
+'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<commit>...]
'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
DESCRIPTION
@@ -28,6 +28,7 @@ OPTIONS
-------
<commit>...::
Commit object names to describe.
+ If not given, defaults to HEAD.
--dirty[=<mark>]::
Describe the working tree.
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index b56e7c3..e57f88c 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -81,7 +81,7 @@ couple of magic command line options:
+
---------------------------------------------
$ git describe -h
-usage: git describe [options] <commit>...
+usage: git describe [options] [<commit>...]
--contains find the tag that comes after the commit
--debug debug search strategy on stderr
diff --git a/builtin/describe.c b/builtin/describe.c
index 4b5a217..82da278 100644
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -12,7 +12,7 @@
#define MAX_TAGS (FLAG_BITS - 1)
static const char * const describe_usage[] = {
- "git describe [options] <commit>...",
+ "git describe [options] [<commit>...]",
"git describe [options] --dirty",
NULL
};
--
1.7.3.2
next prev parent reply other threads:[~2010-12-18 5:39 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-18 5:38 [PATCHv2 0/8] docs: use metavariables consistently Mark Lodato
2010-12-18 5:38 ` [PATCH 1/8] fsck docs: remove outdated and useless diagnostic Mark Lodato
2010-12-18 5:38 ` [PATCH 2/8] docs: use `...' instead of `*' for multiplicity Mark Lodato
2010-12-18 10:00 ` Jakub Narebski
2010-12-18 16:32 ` Mark Lodato
2010-12-18 5:38 ` [PATCH 3/8] docs: use <sha1> to mean unabbreviated ID Mark Lodato
2010-12-18 7:47 ` Jonathan Nieder
2010-12-18 18:50 ` Junio C Hamano
2010-12-18 5:38 ` [PATCH 4/8] http-fetch docs: use <commit-id> consistently Mark Lodato
2010-12-18 7:51 ` Jonathan Nieder
2010-12-18 5:38 ` [PATCH 5/8] grep docs: grep accepts a <tree-ish>, not a <tree> Mark Lodato
2010-12-18 5:38 ` [PATCH 6/8] docs: use <tree> instead of <tree-ish> Mark Lodato
2010-12-18 8:35 ` Jonathan Nieder
2010-12-18 5:38 ` [PATCH 7/8] docs: use <commit> instead of <commit-ish> Mark Lodato
2010-12-18 8:39 ` Jonathan Nieder
2010-12-18 5:38 ` Mark Lodato [this message]
2010-12-18 8:49 ` [PATCHv2 0/8] docs: use metavariables consistently Jonathan Nieder
2010-12-18 16:45 ` Mark Lodato
2010-12-18 20:27 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1292650725-21149-9-git-send-email-lodatom@gmail.com \
--to=lodatom@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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.
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 NNTP newsgroup(s).