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 3/8] docs: use <sha1> to mean unabbreviated ID
Date: Sat, 18 Dec 2010 00:38:40 -0500 [thread overview]
Message-ID: <1292650725-21149-4-git-send-email-lodatom@gmail.com> (raw)
In-Reply-To: <1292650725-21149-1-git-send-email-lodatom@gmail.com>
There are some places that literally require a full, 40-character SHA-1
ID, rather than a generic revision specifier. Introduce in git(1) the
<sha1> terminology to mean this. Use <sha1> in git-diff-tree(1) to note
that --stdin only takes <sha1>s, not generic <tree>s or <commit>s.
Use <tree> and <commit> in the usage statement for 'commit-tree'.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
---
Documentation/git-diff-tree.txt | 4 ++--
Documentation/git.txt | 5 +++++
builtin/commit-tree.c | 2 +-
3 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index a7e37b8..6b357a5 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -49,8 +49,8 @@ include::diff-options.txt[]
--stdin::
When '--stdin' is specified, the command does not take
<tree-ish> arguments from the command line. Instead, it
- reads lines containing either two <tree>, one <commit>, or a
- list of <commit> from its standard input. (Use a single space
+ reads lines containing <sha1>s: either two trees, one commit, or
+ multiple commits from its standard input. (Use a single space
as separator.)
+
When two trees are given, it compares the first tree with the second.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 0128371..7929739 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -457,6 +457,11 @@ list.
Identifier Terminology
----------------------
+<sha1>::
+ Indicates a full, 40-character SHA-1 identifier of an object.
+ The type of the referenced object is unspecified.
+ Abbreviated or symbolic identifiers cannot be used.
+
<object>::
Indicates the object name for any type of object.
diff --git a/builtin/commit-tree.c b/builtin/commit-tree.c
index d083795..da572c3 100644
--- a/builtin/commit-tree.c
+++ b/builtin/commit-tree.c
@@ -9,7 +9,7 @@
#include "builtin.h"
#include "utf8.h"
-static const char commit_tree_usage[] = "git commit-tree <sha1> [(-p <sha1>)...] < changelog";
+static const char commit_tree_usage[] = "git commit-tree <tree> [(-p <commit>)...] < changelog";
static void new_parent(struct commit *parent, struct commit_list **parents_p)
{
--
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 ` Mark Lodato [this message]
2010-12-18 7:47 ` [PATCH 3/8] docs: use <sha1> to mean unabbreviated ID 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 ` [PATCH 8/8] describe docs: note that <commit> is optional Mark Lodato
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-4-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.