Skip to content

Commit f6f32ac

Browse files
committed
Update to describe --choose-* functionality
1 parent 81fc41c commit f6f32ac

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,13 @@ use the `--since` and `--until` options.
9393
If you want to limit the analysis to commits in a certain range use
9494
the `--range` option.
9595

96+
If you want to limit the analysis to a small set of branches or tag
97+
you can used the `--choose-branch` and `choose-tag` options. These options
98+
prune the graph so that only parents of commits with the choose branch
99+
or tag ids are included in the graph. This gives you more detail
100+
controlled that the git options allowed in the --range command. It
101+
is very useful for determining where branches occurred.
102+
96103
You can choose to keep the git output to re-use multiple times with
97104
different display options or to share by specifying the `-k` (`--keep`)
98105
option.
@@ -261,3 +268,9 @@ When you browse to http://localhost:8090/example2.html and you will see this.
261268
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="https://cloud.githubusercontent.com/assets/2991242/22431258/c89d7e7c-e6c5-11e6-826e-cf7450b9f125.png" width="1100" alt="example2">
262269

263270
For such a small graph the crunch operation doesn't really make things simpler but for larger graphs where dot may move the branch and tag information around, it can be a much cleaner view.
271+
272+
There are two more options you will want to think about for make large graphs
273+
more readable: `--choose-branch` and `--choose-tag`. As described earlier,
274+
they prune the graph so that is only considers the parent chains of the
275+
specified branches or tags. This can be very useful to determining where
276+
branches occurred.

git2dot.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@
8181
you can used the --choose-branch and choose-tag options. These options
8282
prune the graph so that only parents of commits with the choose branch
8383
or tag ids are included in the graph. This gives you more detail
84-
controlled that the git options allowed in the --range command.
84+
controlled that the git options allowed in the --range command. It
85+
is very useful for determining where branches occurred.
8586
8687
You can choose to keep the git output to re-use multiple times with
8788
different display options or to share by specifying the -k (--keep)

0 commit comments

Comments
 (0)