git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 3/8] docs: use <sha1> to mean unabbreviated ID

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Dec 18, 2010, 07:47 UTC
Message-ID
<20101218074718.GA6187@burratino>
In-Reply-To
<1292650725-21149-4-git-send-email-lodatom@gmail.com>
Mark Lodato wrote:
> There are some places that literally require a full, 40-character SHA-1
> ID, rather than a generic revision specifier.

One name I have seen for these is "object IDs", as in git get-tar-commit-id (to avoid putting too much emphasis on precisely how the identifiers are chosen).

>                                   Use <sha1> in git-diff-tree(1) to note
> that --stdin only takes <sha1>s, not generic <tree>s or <commit>s.

In this example, maybe it would be cleanest to spell out "40-digit object identifier".

Perhaps something like this? (The text is more verbose than I'd like and it would be nicer to include an example, though.)

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index a7e37b8..85ce185 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -49,9 +49,11 @@ 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
-	as separator.)
+	reads lines, each naming two trees, one commit, or multiple
+	commits, from its standard input.  Each line consists of a
+	list of full 40-digit object identifiers with a single space
+	as separator.  Objects must be named directly; for example,
+	a tag ID cannot be used to represent a commit.
 +
 When two trees are given, it compares the first tree with the second.
 When a single commit is given, it compares the commit with its
Previous: Mark LodatoNext: Junio C Hamano
Message 7 of 19 in “[PATCHv2 0/8] docs: use metavariables consistently”
  1. Mark LodatoDec 18, 2010
  2. 1/8 fsck docs: remove outdated and useless diagnosticMark Lodato, Dec 18, 2010
  3. 2/8 docs: use `...' instead of `*' for multiplicityMark Lodato, Dec 18, 2010
  4. Jakub NarebskiDec 18, 2010
  5. Mark LodatoDec 18, 2010
  6. 3/8 docs: use <sha1> to mean unabbreviated IDMark Lodato, Dec 18, 2010
  7. Jonathan NiederDec 18, 2010
  8. Junio C HamanoDec 18, 2010
  9. 4/8 http-fetch docs: use <commit-id> consistentlyMark Lodato, Dec 18, 2010
  10. Jonathan NiederDec 18, 2010
  11. 5/8 grep docs: grep accepts a <tree-ish>, not a <tree>Mark Lodato, Dec 18, 2010
  12. 6/8 docs: use <tree> instead of <tree-ish>Mark Lodato, Dec 18, 2010
  13. Jonathan NiederDec 18, 2010
  14. 7/8 docs: use <commit> instead of <commit-ish>Mark Lodato, Dec 18, 2010
  15. Jonathan NiederDec 18, 2010
  16. 8/8 describe docs: note that <commit> is optionalMark Lodato, Dec 18, 2010
  17. Jonathan NiederDec 18, 2010
  18. Mark LodatoDec 18, 2010
  19. Junio C HamanoDec 18, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.