From fe09612b403c2aedf78f003f0cae3deba87fc1af Mon Sep 17 00:00:00 2001 From: Garrett Wang Date: Thu, 30 Apr 2020 10:01:08 -0700 Subject: [PATCH 1/5] Update the README.md --- doc/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/README.md b/doc/README.md index 47c3c31862..6aee896f6b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -213,6 +213,10 @@ the graph, controlled by the *nodecount* option. * **"(inline)" Edge Marker**: the call has been inlined into the caller. +* **Green Edges/Nodes**: when [comparing two profiles](#comparing-profiles), the + difference of two values is indicated by a color scale from green to grey to + red, where green is negative, grey is zero and red is positive. + Let's consider the following example graph: ![callgraph](images/callgraph.png) From a281363eeeae0dabbaf40b2a6111fd1f42ee6959 Mon Sep 17 00:00:00 2001 From: Garrett Wang Date: Thu, 30 Apr 2020 10:04:14 -0700 Subject: [PATCH 2/5] Update the README.md --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 6aee896f6b..649e48258b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -213,7 +213,7 @@ the graph, controlled by the *nodecount* option. * **"(inline)" Edge Marker**: the call has been inlined into the caller. -* **Green Edges/Nodes**: when [comparing two profiles](#comparing-profiles), the +* **Green Nodes/Edges**: when [comparing two profiles](#comparing-profiles), the difference of two values is indicated by a color scale from green to grey to red, where green is negative, grey is zero and red is positive. From edd7c8b3aa7bf50a820d9874a2b31b6f54bdc174 Mon Sep 17 00:00:00 2001 From: Garrett Wang Date: Thu, 30 Apr 2020 16:48:28 -0700 Subject: [PATCH 3/5] Update the README.md --- doc/README.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/doc/README.md b/doc/README.md index 649e48258b..3beb6b4e7c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -190,33 +190,31 @@ 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. + * 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 flat values. + * smaller font size means smaller 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. -* **Green Nodes/Edges**: when [comparing two profiles](#comparing-profiles), the - difference of two values is indicated by a color scale from green to grey to - red, where green is negative, grey is zero and red is positive. - Let's consider the following example graph: ![callgraph](images/callgraph.png) From 4b1f87748ebe571c2e1b7dddd8e1c4b2f2e7fc2f Mon Sep 17 00:00:00 2001 From: Garrett Wang Date: Thu, 30 Apr 2020 16:49:51 -0700 Subject: [PATCH 4/5] Update the README.md --- doc/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/README.md b/doc/README.md index 3beb6b4e7c..97e3e1e493 100644 --- a/doc/README.md +++ b/doc/README.md @@ -200,13 +200,13 @@ the graph, controlled by the *nodecount* option. * smaller font size means smaller flat values. * **Edge Weight**: - * thicker edges indicate more resources were used along that path. - * thinner edges indicate fewer resources were used along that path. + * 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. + * 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. From 64bba2c1dcc96f34e1297b167ed074c0a046d609 Mon Sep 17 00:00:00 2001 From: Garrett Wang Date: Fri, 1 May 2020 12:54:37 -0700 Subject: [PATCH 5/5] Update the README.md --- doc/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/README.md b/doc/README.md index 97e3e1e493..a673ae4381 100644 --- a/doc/README.md +++ b/doc/README.md @@ -193,11 +193,11 @@ the graph, controlled by the *nodecount* option. * **Node Color**: * large positive cum values are red. * large negative cum values are green. - * values close to zero are grey. + * cum values close to zero are grey. * **Node Font Size**: - * larger font size means larger flat values. - * smaller font size means smaller flat values. + * 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.