From a6051a6784c7bde7d311b062fbd73644c6a1db6d Mon Sep 17 00:00:00 2001 From: Steven Rostedt Date: Thu, 10 Jun 2010 20:52:42 -0400 Subject: kernelshark: Update the HTML documentation to reflect the filter changes Update the HTML kernelshark documentation to reflect the separation of the list and graph task filters as well as updating the fact that the event filters can now stay in sync. Signed-off-by: Steven Rostedt --- .../HTML/images/kshark-filter-sync-dialog.png | Bin 0 -> 10428 bytes .../HTML/images/kshark-filter-sync-graph-1.png | Bin 71003 -> 66243 bytes Documentation/HTML/images/kshark-filter.png | Bin 64849 -> 65627 bytes Documentation/HTML/images/kshark-unsync-events.png | Bin 0 -> 65044 bytes Documentation/HTML/index.html | 67 ++++++++++++++++----- 5 files changed, 53 insertions(+), 14 deletions(-) create mode 100644 Documentation/HTML/images/kshark-filter-sync-dialog.png create mode 100644 Documentation/HTML/images/kshark-unsync-events.png diff --git a/Documentation/HTML/images/kshark-filter-sync-dialog.png b/Documentation/HTML/images/kshark-filter-sync-dialog.png new file mode 100644 index 0000000..2b975d2 Binary files /dev/null and b/Documentation/HTML/images/kshark-filter-sync-dialog.png differ diff --git a/Documentation/HTML/images/kshark-filter-sync-graph-1.png b/Documentation/HTML/images/kshark-filter-sync-graph-1.png index 82e5849..b5da381 100644 Binary files a/Documentation/HTML/images/kshark-filter-sync-graph-1.png and b/Documentation/HTML/images/kshark-filter-sync-graph-1.png differ diff --git a/Documentation/HTML/images/kshark-filter.png b/Documentation/HTML/images/kshark-filter.png index 0e9a380..6b8cb50 100644 Binary files a/Documentation/HTML/images/kshark-filter.png and b/Documentation/HTML/images/kshark-filter.png differ diff --git a/Documentation/HTML/images/kshark-unsync-events.png b/Documentation/HTML/images/kshark-unsync-events.png new file mode 100644 index 0000000..b5272e5 Binary files /dev/null and b/Documentation/HTML/images/kshark-unsync-events.png differ diff --git a/Documentation/HTML/index.html b/Documentation/HTML/index.html index 12c9957..5d5658c 100644 --- a/Documentation/HTML/index.html +++ b/Documentation/HTML/index.html @@ -401,20 +401,33 @@ cursor. The amount of data that can be stored in a trace.dat file can be enormous. To make any sense out of some traces, it may be required to only display various events. The same can be true about tasks. -Kernelshark has filters for tasks as well as for events. The task filter -affects both the graph and the list, but the graph and list each have a separate -event filter. +Kernelshark has filters for tasks as well as for events. +

+

+On start up of KernelShark, the task and event filters for the list and graph +are kept synchronized. That is, any modification to the list filters will +also update the graph filters, and vice versa. By selecting +Filter->Unsync Graph and List Task Filters or +Filter->Unsync Graph and List Event Filters will make the graph +and list have their own task or event filters respectively. +

Task Filter

-The task filter is currently set by a right mouse click over -an event on either the graph or the list view, and by selecting the option to add or remove the -task to/from the task filter. The tasks within the task filter are the same for -both the graph and list, but each can be enabled separately. +The task filter can be set by either a right mouse click over an event +on either the graph or the list view, and by selecting the option to add or remove the +task to/from the task filter. A set of tasks may be added to the filters +via the Filter menu in the menu bar.

+

+When tasks are selected from the menu bar the filter will be enabled +automatically. When they are selected via the pop up menu, the filter needs to +be enabled by the Enable menu also in the pop up menu. + +

There are two types of task filters:

@@ -463,12 +476,25 @@ This may seem confusing when an event that is hidden shows up in the Task column

Event Filter

-The graph and list view each have their own event filter. The event filters +Like the task filter, the graph and list event filters start off synchronized. +To make the list and graph have their own filter, just select the +Filter->Unsync Graph and List Event Filters. The same can be done +for task filters. +

+ + + +

+Now the graph and list view will each have their own event filter. The event filters are enabled through the Filter menu on the top menu-bar.

+

+Notice that the menu changed after selecting Unsync Graph and List Event Filters. +The events option was replaced by graph events and list events. +

Selecting either the "list events" or "graph events" will bring up the event dialog with the events that are visible selected. @@ -491,20 +517,33 @@ selected. By deselecting all events, it makes it easier to enable just a few ind

-If it is desired that the graph and list view have the same events filtered, then just -set up the desired filtering in one and then synchronize the other through -the filter menu. +To sync back the graph and list events, just select the Sync Graph and List Event Filters.

+

+If the selected events for the graph and list event filters are the same, then +the two will become in-sync again. If not, a dialog will pop up asking how you +want to sync the filters. +

+ + + +

+By default the Keep the filters in sync is selected. If this is selected when +OK is clicked, the graph and list filters will stay synchronized when one is +changed. By unselecting the Keep option, the filters will by synchronized by the +selected method, but a change to one of the filters will not affect the other. +

+

Advanced Event Filter

-- cgit v1.2.2