git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Cc: "Karl Hasselström" <kha@treskal.com>
Subject: [PATCH] fix diff-tree --stdin documentation
Date: Tue, 05 Aug 2008 22:32:28 -0700	[thread overview]
Message-ID: <7v7iauu2s3.fsf_-_@gitster.siamese.dyndns.org> (raw)
In-Reply-To: <7vwsivusy2.fsf@gitster.siamese.dyndns.org> (Junio C. Hamano's message of "Tue, 05 Aug 2008 13:07:17 -0700")

Long time ago, the feature of "diff-tree --stdin" to take a commit and its
parents on one line was broken, and did not support the common:

    git rev-list --parents $commits... -- $paths... |
    git diff-tree --stdin -v -p

usage pattern by Porcelains properly.  For diff-tree to talk sensibly
about commits, it needs to see commits, not just trees; the code was fixed
to take list of commits on the standard input in 1.2.0.

However we left the documentation stale for a long time, until Karl
Hasselström finally noticed it very recently.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 8c8f35b..1fdf20d 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -49,13 +49,13 @@ include::diff-options.txt[]
 --stdin::
 	When '--stdin' is specified, the command does not take
 	<tree-ish> arguments from the command line.  Instead, it
-	reads either one <commit> or a pair of <tree-ish>
+	reads either one <commit> or a list of <commit>
 	separated with a single space from its standard input.
 +
 When a single commit is given on one line of such input, it compares
 the commit with its parents.  The following flags further affects its
-behavior.  This does not apply to the case where two <tree-ish>
-separated with a single space are given.
+behavior.  The remaining commits, when given, are used as if they are
+parents of the first commit.
 
 -m::
 	By default, 'git-diff-tree --stdin' does not show

  reply	other threads:[~2008-08-06  5:33 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-08-05 16:48 [BUG] git diff-tree --stdin doesn't accept two trees Karl Hasselström
2008-08-05 20:07 ` Junio C Hamano
2008-08-06  5:32   ` Junio C Hamano [this message]
2008-08-06 10:04     ` [PATCH] fix diff-tree --stdin documentation Karl Hasselström
2008-08-06 11:53   ` [BUG] git diff-tree --stdin doesn't accept two trees Karl Hasselström
2008-08-06 15:31     ` Junio C Hamano
2008-08-08 20:48       ` [PATCH 0/3] Teach git diff-tree --stdin to diff trees Karl Hasselström
2008-08-08 20:48         ` [PATCH 1/3] Refactoring: Split up diff_tree_stdin Karl Hasselström
2008-08-08 20:48         ` [PATCH 2/3] Teach git diff-tree --stdin to diff trees Karl Hasselström
2008-08-08 21:22           ` Junio C Hamano
2008-08-09  9:56             ` Karl Hasselström
2008-08-09 12:11               ` [PATCH 2/3 v2] " Karl Hasselström
2008-08-09 20:41                 ` Junio C Hamano
2008-08-10 15:38                   ` Karl Hasselström
2008-08-10 16:12                     ` [PATCH v3 0/4] " Karl Hasselström
2008-08-10 16:12                       ` [PATCH v3 1/4] Refactoring: Split up diff_tree_stdin Karl Hasselström
2008-08-10 16:12                       ` [PATCH v3 2/4] diff-tree: Note that the commit ID is printed with --stdin Karl Hasselström
2008-08-10 16:12                       ` [PATCH v3 3/4] Teach git diff-tree --stdin to diff trees Karl Hasselström
2008-08-10 16:13                       ` [PATCH v3 4/4] Add test for diff-tree --stdin with two trees Karl Hasselström
2008-08-10 17:04                       ` [PATCH v3 0/4] Teach git diff-tree --stdin to diff trees Karl Hasselström
2008-08-09 20:07               ` [PATCH 2/3] " Junio C Hamano
2008-08-09 20:36                 ` Karl Hasselström
2008-08-08 21:45           ` Jeff King
2008-08-09 10:00             ` Karl Hasselström
2008-08-11 22:28               ` Jeff King
2008-08-08 20:48         ` [PATCH 3/3] Add test for diff-tree --stdin with two trees Karl Hasselström

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=7v7iauu2s3.fsf_-_@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=kha@treskal.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).