X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-rev-list.txt;h=ad6d14c55aab2144bdac3c313305ba408fe5f0db;hb=8a97e368882afbc2bdc030214339bed54ed6545c;hp=f2c5fa9f4cd598681ccdb6873f98fee5d37e845b;hpb=f1a7eb36b017c62d9a007b6b8660bdeec3f94f97;p=git.git diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index f2c5fa9f..ad6d14c5 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -1,6 +1,5 @@ git-rev-list(1) =============== -v0.1, May 2005 NAME ---- @@ -9,14 +8,100 @@ git-rev-list - Lists commit objects in reverse chronological order SYNOPSIS -------- -'git-rev-list' +[verse] +'git-rev-list' [ \--max-count=number ] + [ \--max-age=timestamp ] + [ \--min-age=timestamp ] + [ \--sparse ] + [ \--no-merges ] + [ \--remove-empty ] + [ \--all ] + [ \--topo-order ] + [ \--parents ] + [ [\--objects | \--objects-edge] [ \--unpacked ] ] + [ \--pretty | \--header ] + [ \--bisect ] + ... [ \-- ... ] 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 '{caret}' cause listing to stop at +that point. Their parents are implied. "git-rev-list foo bar {caret}baz" thus +means "list all the commits which are included in 'foo' and 'bar', but +not in 'baz'". + +A special notation .. can be used as a +short-hand for {caret} . + + +OPTIONS +------- +--pretty:: + Print the contents of the commit changesets in human-readable form. + +--header:: + Print the contents of the commit in raw-format; each + record is separated with a NUL character. + +--objects:: + 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'". + +--objects-edge:: + Similar to `--objects`, but also print the IDs of + excluded commits refixed with a `-` character. This is + used by `git-pack-objects` to build 'thin' pack, which + records objects in deltified form based on objects + contained in these excluded commits to reduce network + traffic. + +--unpacked:: + Only useful with `--objects`; print the object IDs that + are not in packs. + +--bisect:: + Limit output to the one commit object which is roughly halfway + between the included and excluded commits. Thus, if 'git-rev-list + --bisect foo {caret}bar {caret}baz' outputs 'midpoint', the output + of 'git-rev-list foo {caret}midpoint' and 'git-rev-list midpoint + {caret}bar {caret}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. + +--max-count:: + Limit the number of commits output. + +--max-age=timestamp, --min-age=timestamp:: + Limit the commits output to specified time range. + +--sparse:: + When optional paths are given, the command outputs only + the commits that changes at least one of them, and also + ignores merges that do not touch the given paths. This + flag makes the command output all eligible commits + (still subject to count and age limitation), but apply + merge simplification nevertheless. + +--remove-empty:: + Stop when a given path disappears from the tree. + +--all:: + Pretend as if all the refs in `$GIT_DIR/refs/` are + listed on the command line as . + +--topo-order:: + By default, the commits are shown in reverse + chronological order. This option makes them appear in + topological order (i.e. descendant commits are shown + before their parents). Author ------ @@ -28,5 +113,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list