[thirdparty/git.git] / Documentation / git-diff-tree.txt

git-diff-tree(1)
================

NAME
----
git-diff-tree - Compares the content and mode of blobs found via two tree objects


SYNOPSIS
--------
'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]

DESCRIPTION
-----------
Compares the content and mode of the blobs found via two tree objects.

If there is only one <tree-ish> given, the commit is compared with its parents
(see --stdin below).

Note that "git-diff-tree" can use the tree encapsulated in a commit object.

OPTIONS
-------
include::diff-options.txt[]

<tree-ish>::
	The id of a tree object.

<path>...::
	If provided, the results are limited to a subset of files
	matching one of these prefix strings.
	ie file matches `/^<pattern1>|<pattern2>|.../`
	Note that this parameter does not provide any wildcard or regexp
	features.

-r::
        recurse into sub-trees

-t::
	show tree entry itself as well as subtrees.  Implies -r.

--root::
	When '--root' is specified the initial commit will be showed as a big
	creation event. This is equivalent to a diff against the NULL tree.

--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>
	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
behaviour.  This does not apply to the case where two <tree-ish>
separated with a single space are given.

-m::
	By default, "git-diff-tree --stdin" does not show
	differences for merge commits.  With this flag, it shows
	differences to that commit from all of its parents.

-s::
	By default, "git-diff-tree --stdin" shows differences,
	either in machine-readable form (without '-p') or in patch
	form (with '-p').  This output can be supressed.  It is
	only useful with '-v' flag.

-v::
	This flag causes "git-diff-tree --stdin" to also show
	the commit message before the differences.

--pretty[=(raw|medium|short)]::
	This is used to control "pretty printing" format of the
	commit message.  Without "=<style>", it defaults to
	medium.

--no-commit-id::
	git-diff-tree outputs a line with the commit ID when
	applicable.  This flag suppressed the commit ID output.


Limiting Output
---------------
If you're only interested in differences in a subset of files, for
example some architecture-specific files, you might do:

	git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64

and it will only show you what changed in those two directories.

Or if you are searching for what changed in just `kernel/sched.c`, just do

	git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c

and it will ignore all differences to other files.

The pattern is always the prefix, and is matched exactly.  There are no
wildcards.  Even stricter, it has to match a complete path component.
I.e. "foo" does not pick up `foobar.h`.  "foo" does match `foo/bar.h`
so it can be used to name subdirectories.

An example of normal usage is:

  torvalds@ppc970:~/git> git-diff-tree 5319e4......
  *100664->100664 blob    ac348b.......->a01513.......      git-fsck-objects.c

which tells you that the last commit changed just one file (it's from
this one:

-----------------------------------------------------------------------------
commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
tree 5319e4d609cdd282069cc4dce33c1db559539b03
parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005

Make "git-fsck-objects" print out all the root commits it finds.

Once I do the reference tracking, I'll also make it print out all the
HEAD commits it finds, which is even more interesting.
-----------------------------------------------------------------------------

in case you care).

Output format
-------------
include::diff-format.txt[]


Author
------
Written by Linus Torvalds <torvalds@osdl.org>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.

GIT
---
Part of the gitlink:git[7] suite
Commit	Line	Data
2cf565c5 DG	1	git-diff-tree(1)
2cf565c5 DG	2	================
2cf565c5 DG	3
	4	NAME
	5	----
	6	git-diff-tree - Compares the content and mode of blobs found via two tree objects
	7
	8
	9	SYNOPSIS
	10	--------
601c978c	11	'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
2cf565c5 DG	12
	13	DESCRIPTION
	14	-----------
	15	Compares the content and mode of the blobs found via two tree objects.
	16
ff8489cb RW	17	If there is only one <tree-ish> given, the commit is compared with its parents
	18	(see --stdin below).
	19
2cf565c5 DG	20	Note that "git-diff-tree" can use the tree encapsulated in a commit object.
	21
	22	OPTIONS
	23	-------
dda2d79a JH	24	include::diff-options.txt[]
dda2d79a JH	25
2cf565c5 DG	26	<tree-ish>::
	27	The id of a tree object.
	28
232b75ab	29	<path>...::
2cf565c5 DG	30	If provided, the results are limited to a subset of files
	31	matching one of these prefix strings.
	32	ie file matches `/^<pattern1>\|<pattern2>\|.../`
232b75ab	33	Note that this parameter does not provide any wildcard or regexp
2cf565c5 DG	34	features.
2cf565c5 DG	35
50b8e355 CS	36	-r::
	37	recurse into sub-trees
	38
4cae1a96 JH	39	-t::
	40	show tree entry itself as well as subtrees. Implies -r.
	41
0746b620 TG	42	--root::
	43	When '--root' is specified the initial commit will be showed as a big
	44	creation event. This is equivalent to a diff against the NULL tree.
	45
2cf565c5 DG	46	--stdin::
	47	When '--stdin' is specified, the command does not take
	48	<tree-ish> arguments from the command line. Instead, it
	49	reads either one <commit> or a pair of <tree-ish>
	50	separated with a single space from its standard input.
	51	+
	52	When a single commit is given on one line of such input, it compares
	53	the commit with its parents. The following flags further affects its
	54	behaviour. This does not apply to the case where two <tree-ish>
	55	separated with a single space are given.
	56
	57	-m::
	58	By default, "git-diff-tree --stdin" does not show
	59	differences for merge commits. With this flag, it shows
	60	differences to that commit from all of its parents.
	61
	62	-s::
	63	By default, "git-diff-tree --stdin" shows differences,
	64	either in machine-readable form (without '-p') or in patch
	65	form (with '-p'). This output can be supressed. It is
	66	only useful with '-v' flag.
	67
	68	-v::
	69	This flag causes "git-diff-tree --stdin" to also show
	70	the commit message before the differences.
	71
232b75ab JH	72	--pretty[=(raw\|medium\|short)]::
	73	This is used to control "pretty printing" format of the
	74	commit message. Without "=<style>", it defaults to
	75	medium.
	76
601c978c PR	77	--no-commit-id::
	78	git-diff-tree outputs a line with the commit ID when
	79	applicable. This flag suppressed the commit ID output.
	80
2cf565c5 DG	81
	82	Limiting Output
	83	---------------
	84	If you're only interested in differences in a subset of files, for
	85	example some architecture-specific files, you might do:
	86
	87	git-diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64
	88
	89	and it will only show you what changed in those two directories.
	90
	91	Or if you are searching for what changed in just `kernel/sched.c`, just do
	92
	93	git-diff-tree -r <tree-ish> <tree-ish> kernel/sched.c
	94
	95	and it will ignore all differences to other files.
	96
	97	The pattern is always the prefix, and is matched exactly. There are no
2c6e4771	98	wildcards. Even stricter, it has to match a complete path component.
2cf565c5 DG	99	I.e. "foo" does not pick up `foobar.h`. "foo" does match `foo/bar.h`
	100	so it can be used to name subdirectories.
	101
	102	An example of normal usage is:
	103
	104	torvalds@ppc970:~/git> git-diff-tree 5319e4......
215a7ad1	105	*100664->100664 blob ac348b.......->a01513....... git-fsck-objects.c
2cf565c5 DG	106
	107	which tells you that the last commit changed just one file (it's from
	108	this one:
	109
df8baa42 JF	110	-----------------------------------------------------------------------------
	111	commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8
	112	tree 5319e4d609cdd282069cc4dce33c1db559539b03
	113	parent b4e628ea30d5ab3606119d2ea5caeab141d38df7
	114	author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
	115	committer Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005
	116
	117	Make "git-fsck-objects" print out all the root commits it finds.
	118
	119	Once I do the reference tracking, I'll also make it print out all the
	120	HEAD commits it finds, which is even more interesting.
	121	-----------------------------------------------------------------------------
2cf565c5 DG	122
	123	in case you care).
	124
	125	Output format
	126	-------------
	127	include::diff-format.txt[]
	128
	129
	130	Author
	131	------
	132	Written by Linus Torvalds <torvalds@osdl.org>
	133
	134	Documentation
	135	--------------
	136	Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
	137
	138	GIT
	139	---
a7154e91	140	Part of the gitlink:git[7] suite
2cf565c5	141