doc: Document Optimize button

Fixes Bug 508946.

Change-Id: Iead742de3152c81136dc8283a00926372174e95c
Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/91830
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
Tested-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-by: Hudson CI
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>

diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki b/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
index 23bc68d739d0c711e99b2ed570f797f6cb9f11a3..e62df4053a52a76e28277bb6a8476ca0061d3a12 100644 (file)
--- a/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
+++ b/doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
@@ -1989,6 +1989,10 @@ The Control Flow View '''toolbar''', located at the top right of the view, has s
 | Show Legend
 | Displays the states legend.
 |-
+| [[Image:images/Optimization.png]]
+| Optimize
+| "Optimize" the row order of the control flow view. This groups the threads by minimizing the distance in the graph of transitions by CPU for a given time range. The scheduler will often keep tightly coupled threads on the same CPU to preserve data locality. An interesting side effect of this is that threads communicating together in that time range will be moved closer together when pressing the button. The button moves the rows only when pressed. When the time range is moved, the optimization action can be re-applied.
+|-
 | [[Image:images/home_nav.gif]]
 | Reset the Time Scale to Default
 | Resets the zoom window to the full range.

diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/Optimization.png b/doc/org.eclipse.tracecompass.doc.user/doc/images/Optimization.png
new file mode 100644 (file)
index 0000000..8caeb54
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/Optimization.png differ