Skip to content

Commit

Permalink
Update README to reflect what green nodes/edges mean. (#531)
Browse files Browse the repository at this point in the history
* Update the README.md

* Update the README.md

* Update the README.md

* Update the README.md

* Update the README.md
  • Loading branch information
wyk9787 authored May 4, 2020
1 parent fc25d7d commit 160c429
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,27 +190,29 @@ the graph, controlled by the *nodecount* option.

### Interpreting the Callgraph

* **Flat Value**: the value of a location itself. This is indicated by the font
size.
* Nodes with larger font sizes have larger flat values.
* Nodes with smaller font sizes have smaller flat values.
* **Node Color**:
* large positive cum values are red.
* large negative cum values are green.
* cum values close to zero are grey.

* **Cum Value**: the value of a location plus all of its descendants. This is
indicated by the node's color.
* Redder nodes have greater cum values.
* Greyer nodes have smaller cum values.
* **Node Font Size**:
* larger font size means larger absolute flat values.
* smaller font size means smaller absolute flat values.

* **Edge Weight**:
* thicker edges indicate more resources were used along that path.
* thinner edges indicate fewer resources were used along that path.

* **Edge Color**:
* large positive values are red.
* large negative values are green.
* values close to zero are grey.

* **Dashed Edges**: some locations between the two connected locations were
removed.

* **Solid Edges**: one location directly calls the other.

* **Thicker & Redder Edges**: more resources (i.e. larger value) were used
along that path.

* **Thinner & Greyer Edges**: fewer resources (i.e. smaller value) were used
along that path.

* **"(inline)" Edge Marker**: the call has been inlined into the caller.

Let's consider the following example graph:
Expand Down

0 comments on commit 160c429

Please sign in to comment.