diff options
| author | Randy Dunlap <randy.dunlap@oracle.com> | 2010-04-09 13:24:54 -0400 |
|---|---|---|
| committer | Steven Rostedt <rostedt@goodmis.org> | 2010-04-09 13:24:54 -0400 |
| commit | d2c42a8b5238abd33f33e6fe9ae8b48b8670f981 (patch) | |
| tree | 386f86c9f6d8584681e6f23f5bed231963d5482d /Documentation/HTML | |
| parent | 9a6f8264525228eab1baee09f567a5d72c05b0ac (diff) | |
doc: Fix typos and grammar in kernelshark help
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Diffstat (limited to 'Documentation/HTML')
| -rw-r--r-- | Documentation/HTML/index.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/Documentation/HTML/index.html b/Documentation/HTML/index.html index 9ab45a1..8b3062d 100644 --- a/Documentation/HTML/index.html +++ b/Documentation/HTML/index.html | |||
| @@ -133,13 +133,13 @@ zoom into a specific location. | |||
| 133 | The area that you selected will now become the new width of the viewable area. | 133 | The area that you selected will now become the new width of the viewable area. |
| 134 | The smaller the selection, the deeper the zoom. Note, that you must select 10 | 134 | The smaller the selection, the deeper the zoom. Note, that you must select 10 |
| 135 | pixels to zoom in. Less than 10 pixels will cancel the zoom. You can continue zooming | 135 | pixels to zoom in. Less than 10 pixels will cancel the zoom. You can continue zooming |
| 136 | in until you get mor details. | 136 | in until you get more details. |
| 137 | </p> | 137 | </p> |
| 138 | 138 | ||
| 139 | <img src="images/kshark-zoom-in-3.png"> | 139 | <img src="images/kshark-zoom-in-3.png"> |
| 140 | 140 | ||
| 141 | <p> | 141 | <p> |
| 142 | If a plot contains no events within the zoomed in raidus, then the line will be empty, | 142 | If a plot contains no events within the zoomed in radius, then the line will be empty, |
| 143 | as CPU 1 is in the above image. CPU 0 shows two tasks that were running. One task | 143 | as CPU 1 is in the above image. CPU 0 shows two tasks that were running. One task |
| 144 | is given a pink/red color and the other a green color. The colored box represents | 144 | is given a pink/red color and the other a green color. The colored box represents |
| 145 | a task other than idle was running. The small lines that jet out of the box are | 145 | a task other than idle was running. The small lines that jet out of the box are |
| @@ -200,7 +200,7 @@ between the two. All timestamps are in seconds, with a resolution of microsecond | |||
| 200 | <p> | 200 | <p> |
| 201 | Double clicking on the graph will set the cursor. The cursor is a blue line, and when | 201 | Double clicking on the graph will set the cursor. The cursor is a blue line, and when |
| 202 | it is set, it will also select the event in the list view that is the closest event at the | 202 | it is set, it will also select the event in the list view that is the closest event at the |
| 203 | timeline of where the cursor was selected at. | 203 | timeline of where the cursor was selected. |
| 204 | </p> | 204 | </p> |
| 205 | 205 | ||
| 206 | <img src="images/kshark-cursor-1.png"> | 206 | <img src="images/kshark-cursor-1.png"> |
| @@ -227,10 +227,10 @@ in the plot title area. | |||
| 227 | 227 | ||
| 228 | <p> | 228 | <p> |
| 229 | By default, all the CPUs within the loaded trace.dat file are plotted. | 229 | By default, all the CPUs within the loaded trace.dat file are plotted. |
| 230 | There's two ways to plot a process. One way is to right mouse click over a | 230 | There are two ways to plot a process. One way is to right mouse click over a |
| 231 | displayed process in the graph and select the plot option. This will add the | 231 | displayed process in the graph and select the plot option. This will add the |
| 232 | process plot directly underneath the CPU plot that the process was on where | 232 | process plot directly underneath the CPU plot that the process was on where |
| 233 | the right mouse click took place. The other way is to use the plot menu. | 233 | the right mouse click took place. The other way is to use the Plots menu. |
| 234 | </p> | 234 | </p> |
| 235 | 235 | ||
| 236 | <img src="images/kshark-plot-menu.png"> | 236 | <img src="images/kshark-plot-menu.png"> |
| @@ -238,8 +238,8 @@ the right mouse click took place. The other way is to use the plot menu. | |||
| 238 | <h3><a name="graph-plot-task">Process Plots</a></h3> | 238 | <h3><a name="graph-plot-task">Process Plots</a></h3> |
| 239 | 239 | ||
| 240 | <p> | 240 | <p> |
| 241 | Selecting the "Task" menu will bring up a dialog with all the processes (also referred | 241 | Selecting the "Tasks" menu item will bring up a dialog with all the processes (also referred |
| 242 | to as tasks) that was found in the trace data. | 242 | to as tasks) that were found in the trace data. |
| 243 | </p> | 243 | </p> |
| 244 | 244 | ||
| 245 | <img src="images/kshark-plot-task-select.png"> | 245 | <img src="images/kshark-plot-task-select.png"> |
| @@ -287,7 +287,7 @@ latency. The same can be done with the preemption latency. | |||
| 287 | <h3><a name="graph-plot-cpu">CPU Plots</a></h2> | 287 | <h3><a name="graph-plot-cpu">CPU Plots</a></h2> |
| 288 | 288 | ||
| 289 | <p> | 289 | <p> |
| 290 | Selecting the CPU plot menu pops up a dialog that shows the available CPUs that | 290 | Selecting the "CPUs" plot menu item pops up a dialog that shows the available CPUs that |
| 291 | can be plotted. | 291 | can be plotted. |
| 292 | <p> | 292 | <p> |
| 293 | 293 | ||
| @@ -314,7 +314,7 @@ with the paned handle. | |||
| 314 | 314 | ||
| 315 | <p> | 315 | <p> |
| 316 | The top of the list view contains the <a href="#list-area">list area</a> which has the list page, list | 316 | The top of the list view contains the <a href="#list-area">list area</a> which has the list page, list |
| 317 | search, and graph follow toggle button. If more than a million events are stored in the | 317 | search, and "graph follows" toggle button. If more than a million events are stored in the |
| 318 | list, then each set of million will be on a different page. | 318 | list, then each set of million will be on a different page. |
| 319 | </p> | 319 | </p> |
| 320 | 320 | ||
| @@ -330,10 +330,10 @@ resolution. | |||
| 330 | <li><b>PID</b> - The process ID of the task that was running when the event occurred. | 330 | <li><b>PID</b> - The process ID of the task that was running when the event occurred. |
| 331 | <li><b><a name="latency">Latency</a></b> - The latency is broken into 5 fields: | 331 | <li><b><a name="latency">Latency</a></b> - The latency is broken into 5 fields: |
| 332 | <ol> | 332 | <ol> |
| 333 | <li>Interrupts disabled - 'd' if interrupts are enabled, otherwise '.' | 333 | <li>Interrupts disabled - 'd' if interrupts are disabled, otherwise '.' |
| 334 | <li>Need reschedule - 'N' if the kernel was notified that a schedule is needed, otherwise '.' | 334 | <li>Need reschedule - 'N' if the kernel was notified that a schedule is needed, otherwise '.' |
| 335 | <li>In IRQ - 'h' if in a hard IRQ (hardware triggerred), 's' if in a soft IRQ | 335 | <li>In IRQ - 'h' if in a hard IRQ (hardware triggerred), 's' if in a soft IRQ |
| 336 | (context where the kernel initiated a the irq handler) or if soft IRQs | 336 | (context where the kernel initiated a the IRQ handler) or if soft IRQs |
| 337 | are disabled, 'H' if in a hard IRQ and soft IRQs are disabled or the hard IRQ | 337 | are disabled, 'H' if in a hard IRQ and soft IRQs are disabled or the hard IRQ |
| 338 | triggerred while processing a soft IRQ, otherwise '.' | 338 | triggerred while processing a soft IRQ, otherwise '.' |
| 339 | <li>Preemption counter - The index of the preemption counter. If it is other | 339 | <li>Preemption counter - The index of the preemption counter. If it is other |
| @@ -341,7 +341,7 @@ resolution. | |||
| 341 | if a schedule has been requested by some event. If the counter is zero, | 341 | if a schedule has been requested by some event. If the counter is zero, |
| 342 | then '.' is shown. | 342 | then '.' is shown. |
| 343 | <li>Lock depth - The depth of the big kernel lock being held. The big kernel | 343 | <li>Lock depth - The depth of the big kernel lock being held. The big kernel |
| 344 | lock is recusive (same task may acquire it multiple times). On the first | 344 | lock is recursive (same task may acquire it multiple times). On the first |
| 345 | acquisition, the depth is zero. This field will be zero or greater, or | 345 | acquisition, the depth is zero. This field will be zero or greater, or |
| 346 | '.' if the big kernel lock is not held. When the big kernel lock is | 346 | '.' if the big kernel lock is not held. When the big kernel lock is |
| 347 | finally removed from the kernel, this field will go away as well. | 347 | finally removed from the kernel, this field will go away as well. |
| @@ -352,8 +352,8 @@ resolution. | |||
| 352 | 352 | ||
| 353 | <p> | 353 | <p> |
| 354 | The list search can find an event based on the contents in a row. Select a column, a | 354 | The list search can find an event based on the contents in a row. Select a column, a |
| 355 | match criteria and the content to match will find the next row that matches the | 355 | match criteria and the content to match to find the next row that matches the |
| 356 | search. The match criteria is one of the following: | 356 | search. The match criterion is one of the following: |
| 357 | </p> | 357 | </p> |
| 358 | 358 | ||
| 359 | <ul> | 359 | <ul> |
| @@ -371,7 +371,7 @@ The search will find the next event that has the matching data within the column | |||
| 371 | <p> | 371 | <p> |
| 372 | A single click on a row will select the row, but a double click on a row will select | 372 | A single click on a row will select the row, but a double click on a row will select |
| 373 | that row as well as set the graph cursor to the location of that event. If the plot | 373 | that row as well as set the graph cursor to the location of that event. If the plot |
| 374 | that the event is on is not visible then the graph will adjust it vertical view area | 374 | that the event is on is not visible then the graph will adjust its vertical view area |
| 375 | to show the plot with the selected event. This has no effect on | 375 | to show the plot with the selected event. This has no effect on |
| 376 | <a href="#graph-marker">graph markers</a>. | 376 | <a href="#graph-marker">graph markers</a>. |
| 377 | <p> | 377 | <p> |
| @@ -392,7 +392,7 @@ cursor. | |||
| 392 | <h1><a name="filters">Filters</a></h1> | 392 | <h1><a name="filters">Filters</a></h1> |
| 393 | 393 | ||
| 394 | <p> | 394 | <p> |
| 395 | The amount of data that can be stored in a trace.dat file can be enourmous. | 395 | The amount of data that can be stored in a trace.dat file can be enormous. |
| 396 | To make any sense out of some traces, it may be required to only display various | 396 | To make any sense out of some traces, it may be required to only display various |
| 397 | events. The same can be true about processes. | 397 | events. The same can be true about processes. |
| 398 | Kernelshark has filters for tasks as well as for events. The task filter | 398 | Kernelshark has filters for tasks as well as for events. The task filter |
| @@ -459,13 +459,13 @@ dialog with the events that are visible selected. | |||
| 459 | <p> | 459 | <p> |
| 460 | Note: these do not mean that the events exist in the trace.dat file. They are | 460 | Note: these do not mean that the events exist in the trace.dat file. They are |
| 461 | selected if the events are not to be hidden. Events that do not exist in the trace | 461 | selected if the events are not to be hidden. Events that do not exist in the trace |
| 462 | and will not be displayed regardless of whether or not they are filtered. | 462 | will not be displayed regardless of whether or not they are filtered. |
| 463 | </p> | 463 | </p> |
| 464 | 464 | ||
| 465 | <img src="images/kshark-filter-events.png"> | 465 | <img src="images/kshark-filter-events.png"> |
| 466 | 466 | ||
| 467 | <p> | 467 | <p> |
| 468 | By clicking on "All" or any of the systems will either deselect all events underneath | 468 | Clicking on "All" or any of the systems will either deselect all events underneath |
| 469 | or select all events underneath depending on the previous state of the box being | 469 | or select all events underneath depending on the previous state of the box being |
| 470 | selected. By deselecting all events, it makes it easier to enable just a few individual events. | 470 | selected. By deselecting all events, it makes it easier to enable just a few individual events. |
| 471 | <p> | 471 | <p> |
| @@ -487,13 +487,13 @@ as what is in the list filter. | |||
| 487 | as what is in the graph filter. | 487 | as what is in the graph filter. |
| 488 | </ul> | 488 | </ul> |
| 489 | 489 | ||
| 490 | <h3><a name="filter-adv-event">Advance Event Filter</a></h3> | 490 | <h3><a name="filter-adv-event">Advanced Event Filter</a></h3> |
| 491 | 491 | ||
| 492 | <p> | 492 | <p> |
| 493 | Filtering on events may not be enough. The ability to filter on the content | 493 | Filtering on events may not be enough. The ability to filter on the content |
| 494 | of individual events may be needed. In order to accomplish this, the advanced event | 494 | of individual events may be needed. In order to accomplish this, the advanced event |
| 495 | filtering is used. Selecting the "list advanced event" or "graph advanced event" | 495 | filtering is used. Selecting the "list advanced event" or "graph advanced event" |
| 496 | from the filter menu will pop up the advanced event filtering dialog. | 496 | from the Filter menu will pop up the advanced event filtering dialog. |
| 497 | The graph and list view each have their own advanced event filter. | 497 | The graph and list view each have their own advanced event filter. |
| 498 | </p> | 498 | </p> |
| 499 | 499 | ||
| @@ -570,7 +570,7 @@ the above filters would be equivalent to: | |||
| 570 | </pre> | 570 | </pre> |
| 571 | 571 | ||
| 572 | <p> | 572 | <p> |
| 573 | By letting the filters contain fields that do not belong to an event be valid, | 573 | Letting filters contain fields that do not belong to an event be valid |
| 574 | allows for various tricks where two events can share the same | 574 | allows for various tricks where two events can share the same |
| 575 | filter. | 575 | filter. |
| 576 | </p> | 576 | </p> |
| @@ -587,7 +587,7 @@ part of the <tt>||</tt> | |||
| 587 | </p> | 587 | </p> |
| 588 | 588 | ||
| 589 | <p> | 589 | <p> |
| 590 | Notice: that event names in the filter can be regular expressions. | 590 | Notice that event names in the filter can be regular expressions. |
| 591 | </p> | 591 | </p> |
| 592 | 592 | ||
| 593 | <p> | 593 | <p> |
| @@ -600,28 +600,28 @@ String fields can have regular expressions used in their comparing if | |||
| 600 | </pre> | 600 | </pre> |
| 601 | 601 | ||
| 602 | <p> | 602 | <p> |
| 603 | Note: When adding an advanced filter, all non advanced filters | 603 | Note: When adding an advanced filter, all non-advanced filters |
| 604 | (added by the event filter dialog box) will be removed, and only the advanced | 604 | (added by the event filter dialog box) will be removed, and only the advanced |
| 605 | filters will stay. But non advanced filters may be added after advanced | 605 | filters will stay. But non-advanced filters may be added after advanced |
| 606 | filters have been. The events that have advanced filters will be shadowed | 606 | filters have been. The events that have advanced filters will be shaded |
| 607 | in the event filter dialog: | 607 | in the event filter dialog: |
| 608 | <p> | 608 | <p> |
| 609 | 609 | ||
| 610 | <img src="images/kshark-filter-event-adv-list.png"> | 610 | <img src="images/kshark-filter-event-adv-list.png"> |
| 611 | 611 | ||
| 612 | <p> | 612 | <p> |
| 613 | Just do not click on the adavanced filter box and hit "Apply" unless you want to remove | 613 | Just do not click on the advanced filter box and hit "Apply" unless you want to remove |
| 614 | the adavanced filter. Non advanced filters can now be selected without affecting | 614 | the advanced filter. Non-advanced filters can now be selected without affecting |
| 615 | the advanced filters. | 615 | the advanced filters. |
| 616 | </p> | 616 | </p> |
| 617 | 617 | ||
| 618 | <img src="images/kshark-filter-list-adv-irq.png"> | 618 | <img src="images/kshark-filter-list-adv-irq.png"> |
| 619 | 619 | ||
| 620 | <p> | 620 | <p> |
| 621 | When adavanced filters already exist when the advanced filter dialog box pops up, | 621 | When advanced filters already exist when the advanced filter dialog box pops up, |
| 622 | they will be listed in the area at the top of the dialog. Although | 622 | they will be listed in the area at the top of the dialog. Although |
| 623 | one filter may have been written, the list will be per event. A check box | 623 | one filter may have been written, the list will be per event. A check box |
| 624 | is to the left of the filter, when checked, the filter will be deleted if | 624 | is to the left of the filter. When checked, the filter will be deleted if |
| 625 | the "Apply" button is selected. | 625 | the "Apply" button is selected. |
| 626 | </p> | 626 | </p> |
| 627 | 627 | ||
