Skip to content

Commit e989cc7

Browse files
authored
Update README.md
1 parent 1503969 commit e989cc7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,3 +444,29 @@ $ ./git2dot.py -s -c --png --graph-label 'graph[label="git2dot v0.6", fontsize="
444444
4. If you only want to see the combined history of a few branches or tags (like release branches) consider using the `--choose-branch` and `--choose-tag` options to prune the graph.
445445
5. Use the `--since` option if you don't care about ancient history.
446446
6. The `--graph-label` option can be useful and can be very simple: `--graph-label 'graph[label="MY LABEL"]'`.
447+
448+
## Summary data
449+
The generated dot file has summary fields at the end that can be useful for post processing.
450+
451+
The fields are written as dot comments like this.
452+
453+
```
454+
// summary:num_graph_commit_nodes 5
455+
// summary:num_graph_merge_nodes 1
456+
// summary:num_graph_squash_nodes 2
457+
// summary:total_commits 12
458+
// summary:total_graph_commit_nodes 8
459+
```
460+
461+
They are described in the table below.
462+
463+
| Field | Description |
464+
| ----- | ----------- |
465+
| `// summary:num_graph_commit_nodes INT` | The total number of simple commit nodes in the graph. |
466+
| `// summary:num_graph_merge_nodes INT` | The total nummber of merge commit nodes in the graph. |
467+
| `// summary:num_graph_squash_nodes INT` | The total number of squash commit nodes in the graph. |
468+
| `// summary:total_commits INT` | The total number of commits (incuding merges) with no squashing. |
469+
| `// summary:total_graph_commit_nodes INT` | The number of actual commit nodes in the graph. |
470+
471+
Note that total_commits and total_graph_commit_nodes will be the same if squashing is not specified.
472+

0 commit comments

Comments
 (0)