From adcd3512f5e499a3cc14b865e83580b8c3d235c1 Mon Sep 17 00:00:00 2001 From: Matthias Urlichs Date: Fri, 29 Jul 2005 20:10:46 +0200 Subject: [PATCH] [PATCH] document git-rev-list better Document new (and not-so-new) flags of git-rev-list. Signed-off-By: Matthias Urlichs Signed-off-by: Junio C Hamano --- Documentation/git-rev-list.txt | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index fe86c9c26d..35fecf3f83 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -9,14 +9,35 @@ git-rev-list - Lists commit objects in reverse chronological order SYNOPSIS -------- -'git-rev-list' [ *--max-count*=number ] [ *--max-age*=timestamp ] [ *--min-age*=timestamp ] [ *--merge-order* [ *--show-breaks* ] ] +'git-rev-list' [ *--max-count*=number ] [ *--max-age*=timestamp ] [ *--min-age*=timestamp ] [ *--bisect* ] [ *--pretty* ] [ *--objects* ] [ *--merge-order* [ *--show-breaks* ] ] [ ...] [ ^ ...] DESCRIPTION ----------- 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. +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 unique sequence of minimal, non-linear epochs and maximal, linear epochs. Non-linear epochs are then linearised by sorting them into merge order, which