mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[PATCH] document git-rev-list better

Browse Source 
Document new (and not-so-new) flags of git-rev-list.

Signed-off-By: Matthias Urlichs <smurf@smurf.noris.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Matthias Urlichs
2005-07-29 20:10:46 +02:00
committed by Junio C Hamano
parent 623c8a1460
commit adcd3512f5
1 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
Documentation/git-rev-list.txt
View File

@ -9,14 +9,35 @@ git-rev-list - Lists commit objects in reverse chronological order
SYNOPSIS SYNOPSIS
-------- --------
'git-rev-list' [ *--max-count*=number ] [ *--max-age*=timestamp ] [ *--min-age*=timestamp ] [ *--merge-order* [ *--show-breaks* ] ] <commit> 'git-rev-list' [ *--max-count*=number ] [ *--max-age*=timestamp ] [ *--min-age*=timestamp ] [ *--bisect* ] [ *--pretty* ] [ *--objects* ] [ *--merge-order* [ *--show-breaks* ] ] <commit> [ <commit> ...] [ ^<commit> ...]
DESCRIPTION DESCRIPTION
----------- -----------
Lists commit objects in reverse chronological order starting at the Lists commit objects in reverse chronological order starting at the
given commit, taking ancestry relationship into account. This is given commit(s), taking ancestry relationship into account. This is
useful to produce human-readable log output. useful to produce human-readable log output.
Commits which are stated with a preceding '^' cause listing to stop at
that point. Their parents are implied. "git-rev-list foo bar ^baz" thus
means "list all the commits which are included in 'foo' and 'bar', but
not in 'baz'".
If *--pretty* is specified, print the contents of the commit changesets
in human-readable form.
The *--objects* flag causes 'git-rev-list' to print the object IDs of
any object referenced by the listed commits. 'git-rev-list --objects foo
^bar' thus means "send me all object IDs which I need to download if
I have the commit object 'bar', but not 'foo'".
The *--bisect* flag limits output to the one commit object which is
roughly halfway between the included and excluded commits. Thus,
if "git-rev-list --bisect foo ^bar ^baz" outputs 'midpoint', the output
of "git-rev-list foo ^midpoint" and "git-rev-list midpoint ^bar ^baz"
would be of roughly the same length. Finding the change which introduces
a regression is thus reduced to a binary search: repeatedly generate and
test new 'midpoint's until the commit chain is of length one.
If *--merge-order* is specified, the commit history is decomposed into a If *--merge-order* is specified, the commit history is decomposed into a
unique sequence of minimal, non-linear epochs and maximal, linear epochs. unique sequence of minimal, non-linear epochs and maximal, linear epochs.
Non-linear epochs are then linearised by sorting them into merge order, which Non-linear epochs are then linearised by sorting them into merge order, which