diff options
author | Steven Rostedt <rostedt@goodmis.org> | 2010-06-10 20:52:42 -0400 |
---|---|---|
committer | Steven Rostedt <rostedt@goodmis.org> | 2010-06-10 20:52:42 -0400 |
commit | a6051a6784c7bde7d311b062fbd73644c6a1db6d (patch) | |
tree | db5288542e63cd9719fd0ea271d211ba41149c15 | |
parent | cfb08f6326b43a80ff41edfde9ba70e49e9af0d0 (diff) |
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 <rostedt@goodmis.org>
-rw-r--r-- | Documentation/HTML/images/kshark-filter-sync-dialog.png | bin | 0 -> 10428 bytes | |||
-rw-r--r-- | Documentation/HTML/images/kshark-filter-sync-graph-1.png | bin | 71003 -> 66243 bytes | |||
-rw-r--r-- | Documentation/HTML/images/kshark-filter.png | bin | 64849 -> 65627 bytes | |||
-rw-r--r-- | Documentation/HTML/images/kshark-unsync-events.png | bin | 0 -> 65044 bytes | |||
-rw-r--r-- | Documentation/HTML/index.html | 67 |
5 files changed, 53 insertions, 14 deletions
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 --- /dev/null +++ b/Documentation/HTML/images/kshark-filter-sync-dialog.png | |||
Binary files 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 --- a/Documentation/HTML/images/kshark-filter-sync-graph-1.png +++ b/Documentation/HTML/images/kshark-filter-sync-graph-1.png | |||
Binary files differ | |||
diff --git a/Documentation/HTML/images/kshark-filter.png b/Documentation/HTML/images/kshark-filter.png index 0e9a380..6b8cb50 100644 --- a/Documentation/HTML/images/kshark-filter.png +++ b/Documentation/HTML/images/kshark-filter.png | |||
Binary files 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 --- /dev/null +++ b/Documentation/HTML/images/kshark-unsync-events.png | |||
Binary files 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,21 +401,34 @@ cursor. | |||
401 | The amount of data that can be stored in a trace.dat file can be enormous. | 401 | The amount of data that can be stored in a trace.dat file can be enormous. |
402 | To make any sense out of some traces, it may be required to only display various | 402 | To make any sense out of some traces, it may be required to only display various |
403 | events. The same can be true about tasks. | 403 | events. The same can be true about tasks. |
404 | Kernelshark has filters for tasks as well as for events. The task filter | 404 | Kernelshark has filters for tasks as well as for events. |
405 | affects both the graph and the list, but the graph and list each have a separate | 405 | </p> |
406 | event filter. | 406 | |
407 | <p> | 407 | <p> |
408 | On start up of KernelShark, the task and event filters for the list and graph | ||
409 | are kept synchronized. That is, any modification to the list filters will | ||
410 | also update the graph filters, and vice versa. By selecting | ||
411 | <b>Filter->Unsync Graph and List Task Filters</b> or | ||
412 | <b>Filter->Unsync Graph and List Event Filters</b> will make the graph | ||
413 | and list have their own task or event filters respectively. | ||
414 | </b> | ||
408 | 415 | ||
409 | <h2><a name="filter-task">Task Filter</a></h2> | 416 | <h2><a name="filter-task">Task Filter</a></h2> |
410 | 417 | ||
411 | <p> | 418 | <p> |
412 | The task filter is currently set by a right mouse click over | 419 | The task filter can be set by either a right mouse click over an event |
413 | an event on either the graph or the list view, and by selecting the option to add or remove the | 420 | on either the graph or the list view, and by selecting the option to add or remove the |
414 | task to/from the task filter. The tasks within the task filter are the same for | 421 | task to/from the task filter. A set of tasks may be added to the filters |
415 | both the graph and list, but each can be enabled separately. | 422 | via the <b>Filter</b> menu in the menu bar. |
416 | </p> | 423 | </p> |
417 | 424 | ||
418 | <p> | 425 | <p> |
426 | When tasks are selected from the menu bar the filter will be enabled | ||
427 | automatically. When they are selected via the pop up menu, the filter needs to | ||
428 | be enabled by the <b>Enable</b> menu also in the pop up menu. | ||
429 | </b> | ||
430 | |||
431 | <p> | ||
419 | There are two types of task filters: | 432 | There are two types of task filters: |
420 | </p> | 433 | </p> |
421 | 434 | ||
@@ -463,13 +476,26 @@ This may seem confusing when an event that is hidden shows up in the Task column | |||
463 | <h2><a name="filter-event">Event Filter</a></h2> | 476 | <h2><a name="filter-event">Event Filter</a></h2> |
464 | 477 | ||
465 | <p> | 478 | <p> |
466 | The graph and list view each have their own event filter. The event filters | 479 | Like the task filter, the graph and list event filters start off synchronized. |
480 | To make the list and graph have their own filter, just select the | ||
481 | <b>Filter->Unsync Graph and List Event Filters</b>. The same can be done | ||
482 | for task filters. | ||
483 | </p> | ||
484 | |||
485 | <img src="images/kshark-unsync-events.png"> | ||
486 | |||
487 | <p> | ||
488 | Now the graph and list view will each have their own event filter. The event filters | ||
467 | are enabled through the Filter menu on the top menu-bar. | 489 | are enabled through the Filter menu on the top menu-bar. |
468 | </p> | 490 | </p> |
469 | 491 | ||
470 | <img src="images/kshark-filter.png"> | 492 | <img src="images/kshark-filter.png"> |
471 | 493 | ||
472 | <p> | 494 | <p> |
495 | Notice that the menu changed after selecting <b>Unsync Graph and List Event Filters</b>. | ||
496 | The <b>events</b> option was replaced by <b>graph events</b> and <b>list events</b>. | ||
497 | |||
498 | <p> | ||
473 | Selecting either the "list events" or "graph events" will bring up the event | 499 | Selecting either the "list events" or "graph events" will bring up the event |
474 | dialog with the events that are visible selected. | 500 | dialog with the events that are visible selected. |
475 | </p> | 501 | </p> |
@@ -491,20 +517,33 @@ selected. By deselecting all events, it makes it easier to enable just a few ind | |||
491 | <img src="images/kshark-filter-events-sched.png"> | 517 | <img src="images/kshark-filter-events-sched.png"> |
492 | 518 | ||
493 | <p> | 519 | <p> |
494 | If it is desired that the graph and list view have the same events filtered, then just | 520 | To sync back the graph and list events, just select the <b>Sync Graph and List Event Filters</b>. |
495 | set up the desired filtering in one and then synchronize the other through | ||
496 | the filter menu. | ||
497 | </p> | 521 | </p> |
498 | 522 | ||
499 | <img src="images/kshark-filter-sync-graph-1.png"> | 523 | <img src="images/kshark-filter-sync-graph-1.png"> |
500 | 524 | ||
525 | <p> | ||
526 | If the selected events for the graph and list event filters are the same, then | ||
527 | the two will become in-sync again. If not, a dialog will pop up asking how you | ||
528 | want to sync the filters. | ||
529 | </p> | ||
530 | |||
531 | <img src="images/kshark-filter-sync-dialog.png"> | ||
532 | |||
501 | <ul> | 533 | <ul> |
502 | <li><b>sync graph events with list</b> - will set the graph event filter to be the same | 534 | <li><b>Sync List Filter with Graph Filter</b> - will set the list event filter to be the same |
503 | as what is in the list filter. | ||
504 | <li><b>sync list events with graph</b> - will set the list event filter to be the same | ||
505 | as what is in the graph filter. | 535 | as what is in the graph filter. |
536 | <li><b>Sync Graph Filter with List Filter</b> - will set the graph event filter to be the same | ||
537 | as what is in the list filter. | ||
506 | </ul> | 538 | </ul> |
507 | 539 | ||
540 | <p> | ||
541 | By default the <b>Keep the filters in sync</b> is selected. If this is selected when | ||
542 | <b>OK</b> is clicked, the graph and list filters will stay synchronized when one is | ||
543 | changed. By unselecting the <b>Keep</b> option, the filters will by synchronized by the | ||
544 | selected method, but a change to one of the filters will not affect the other. | ||
545 | </p> | ||
546 | |||
508 | <h3><a name="filter-adv-event">Advanced Event Filter</a></h3> | 547 | <h3><a name="filter-adv-event">Advanced Event Filter</a></h3> |
509 | 548 | ||
510 | <p> | 549 | <p> |