Skip to content

Commit 1710541

Browse files
Updating the PerfView documentation (#2092)
* Update UsersGuide.htm Cleaning up the documentation. * Update UsersGuide.htm More documentation cleanup.
1 parent 1051411 commit 1710541

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

src/PerfView/SupportFiles/UsersGuide.htm

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -729,13 +729,13 @@ <h3>
729729
The <strong>Collect-&gt;Run</strong> (Alt-R) menu item, which prompts for a data file
730730
name to create and a command to run.&nbsp;&nbsp; The command turns on profiling,
731731
runs the command, and then turns profiling off.&nbsp; The resulting file is then
732-
display in the stack viewer.&nbsp;&nbsp; This is the preferred mechanism when it
732+
displayed in the stack viewer.&nbsp;&nbsp; This is the preferred mechanism when it
733733
is easy to launch the application of interest.&nbsp;&nbsp; If the command produces
734734
output, it will be captured in the log (click the &#39;Log&#39; button in the lower
735735
right corner of the main view).&nbsp;
736736
</li>
737737
<li>
738-
The <strong>Collect-&gt;Collect </strong>(Alt-C) menu item which only prompt for a
738+
The <strong>Collect-&gt;Collect </strong>(Alt-C) menu item which only prompts for a
739739
data file name to create. After clicking the 'Start Collection' button you are then
740740
free to interact with machine in any way necessary to capture the activity of interest.&nbsp;&nbsp;
741741
Since profiling is machine wide you are guaranteed to capture it.&nbsp;&nbsp; Once
@@ -753,7 +753,7 @@ <h3>
753753
</p>
754754
<p>
755755
By default PerfView chooses a set of events that does not generate too much data
756-
but it useful for a variety of investigations. However
756+
but is useful for a variety of investigations. However
757757
<a href="#BlockedTimeInvestigation">wall clock investigations</a>
758758
require events that are too voluminous to collect by default. Thus if you wish to
759759
do a wall clock investigation, you need to set the 'Thread Time' checkbox in the
@@ -765,18 +765,18 @@ <h3>
765765
<p>
766766
By default to save time PerfView does NOT prepare the ETL file so that it can be
767767
analyzed on a different machine (see <a href="#merging">merging</a>). Moreover,
768-
there is symbolic information (PDBS for NGEN images), that also need to be included
768+
there is symbolic information (PDBS for NGEN images), that also needs to be included
769769
if the data is to work well on any machine). If you are intending to do this you
770770
need to merge and include the NGEN pdbs by using the 'ZIP' command. You can do this
771-
either
771+
either by
772772
</p>
773773
<ul>
774774
<li>
775775
Checking the 'Zip' checkbox on the data collection dialog box when the data is being
776776
created.
777777
</li>
778778
<li>
779-
By specifying the /Zip qualifier on the command line of PerfView when the data is
779+
Specifying the /Zip qualifier on the command line of PerfView when the data is
780780
being created.
781781
</li>
782782
<li>Right clicking on existing ETL file in the main viewer and selecting the ZIP option.</li>
@@ -799,13 +799,13 @@ <h3>
799799
<p>
800800
The result of collecting data is an ETL file (and possibly a .kernel.ETL file as
801801
discussed in <a href="#merging">merging</a>).&nbsp;&nbsp;&nbsp; When you double
802-
click on the file in the main viewer it opens up &#39;children views&#39;&nbsp;
802+
click on the file in the main viewer it opens up &#39;children views&#39;
803803
of the data that was collected.&nbsp;&nbsp; One of these items will be the &#39;CPU
804804
Stacks&#39; view.&nbsp;&nbsp;&nbsp; Double clicking on that will bring up a stack
805805
viewer to view the samples collected.&nbsp;&nbsp;&nbsp; The data in the ETL file
806806
contains CPU information for ALL processes in the system,&nbsp; however most analyses
807807
concentrate on a single process.&nbsp;&nbsp; Because of this before the stack viewer
808-
is displayed a dialog box to select a process of interests is displayed first.&nbsp;
808+
is displayed a dialog box to select a process of interest is displayed first.&nbsp;
809809
</p>
810810
<p>
811811
By default, this dialog box contains a list of all processes that were active at
@@ -815,15 +815,15 @@ <h3>
815815
will bring up the stack viewer filtered to the process you chose.
816816
</p>
817817
<p>
818-
The process view can be sorted by any of the columns by clicking on column header.&nbsp;
818+
The process view can be sorted by any of the columns by clicking on the column header.&nbsp;
819819
Thus if you wish to find the process that was started most recently you can sort
820820
by start time to find it quickly.&nbsp;&nbsp; If the view is sorted by name, if
821821
you type the first character of the process name it will navigate to the first process
822822
with that name.&nbsp;
823823
</p>
824824
<p>
825825
<a id="ProcessFilterTextBox"><strong>Process Filter Textbox</strong></a> The box just
826-
above the list of process.&nbsp;&nbsp; If you type text in this box, then only
826+
above the list of processes.&nbsp;&nbsp; If you type text in this box, then only
827827
processes that match this string (PID, process name or command line, case insensitive) will
828828
be displayed. &nbsp;&nbsp; The * character is a wild card.&nbsp;&nbsp; This is a quick
829829
way of finding a particular process.
@@ -833,7 +833,7 @@ <h3>
833833
&#39;All Procs&#39; button.&nbsp;&nbsp;&nbsp;&nbsp;
834834
</p>
835835
<p>
836-
Note that the ONLY effect of the process selection dialog box is to add an &#39;<a href="#IncPatsTextBox">Inc Pats</a>&#39; filter that matches the process your
836+
Note that the ONLY effect of the process selection dialog box is to add an &#39;<a href="#IncPatsTextBox">Inc Pats</a>&#39; filter that matches the process you
837837
chose.&nbsp;&nbsp; Thus the dialog box is really just a &#39;friendly interface&#39;
838838
to the more powerful <a href="#FilteringGroupingStackData">filtering options</a>
839839
of the stack viewer.&nbsp;&nbsp; In particular, the stack viewer still has access

0 commit comments

Comments
 (0)