svn commit: r280699 - head/usr.sbin/pmcstudy

[Christian Brueffer]

Author: brueffer
Date: Thu Mar 26 15:54:54 2015
New Revision: 280699
URL: https://svnweb.freebsd.org/changeset/base/280699

Log:
  Rough first mdoc, spelling and grammar cleanup pass.

Modified:
  head/usr.sbin/pmcstudy/pmcstudy.8

Modified: head/usr.sbin/pmcstudy/pmcstudy.8
==============================================================================
--- head/usr.sbin/pmcstudy/pmcstudy.8	Thu Mar 26 15:43:57 2015	(r280698)
+++ head/usr.sbin/pmcstudy/pmcstudy.8	Thu Mar 26 15:54:54 2015	(r280699)
@@ -29,14 +29,14 @@
 .Os
 .Sh NAME
 .Nm pmcstudy
-.Nd Perform various study's on a systems overall PMC's.
+.Nd Perform various studies on a system's overall PMCs.
 .Sh SYNOPSIS
 .Nm
 .Oo Fl i Ar inputfile | Fl T | Fl v | Fl m Ar max | Fl e exp | Fl Ar E | Fl h | fl H Oc
-.Nm 
-.Fl i Ar inputfile 
 .Nm
-.Fl v 
+.Fl i Ar inputfile
+.Nm
+.Fl v
 .Nm
 .Fl m Ar max
 .Nm
@@ -53,23 +53,25 @@
 The
 .Nm
 program is designed to run various tests against your systems
-performance. There are roughly 20-22 canned tests that setup specific
-PMC's and then run various formulas on the output information.
+performance.
+There are roughly 20-22 canned tests that setup specific
+PMCs and then run various formulas on the output information.
 These formulas can be found in Intel documentation "Using Intel Vtune
-amplifier xe on NNN Generation Intel Core Processors". The NNN is either
-2nd, 3rd or 4th generation i.e. Sandy Bridge, Ivy Bridge and Haswell. 
+amplifier xe on NNN Generation Intel Core Processors".
+The NNN is either
+2nd, 3rd or 4th generation i.e., Sandy Bridge, Ivy Bridge and Haswell.
 Currently the program only works on these three Intel processor types.
 .Sh OPTIONS
 The following options are available:
 .Bl -tag -width indent
 .It Fl i Ar filename
 If this option is supplied, instead of running a
-.Xr pmcstat 8 
-command to collecte the current running information the filename will be read
+.Xr pmcstat 8
+command to collect the current running information the filename will be read
 in as input instead.
 .It Fl H
 This option will display the complete list of canned formulas that can be run including
-there names which can be input to the
+their names which can be input to the
 .Fl e
 option.
 .It Fl e Ar name
@@ -83,22 +85,28 @@ option the test will not execute but ins
 of the test that would run.
 .It Fl T
 This option will execute a test of every PMC to validate that they are working
-on your system. If a PMC does not show up in this test chances
-are the kernel hwpmc driver needs updating with new PMC information.
+on your system.
+If a PMC does not show up in this test chances
+are the kernel
+.Xr hwpmc 4
+driver needs updating with new PMC information.
 .It Fl m Ar num
 This option can restrict the number of one second samples that will
 be collected by your system when running a test (it bounds the
-time the test will run). Without this option the test will run
+time the test will run).
+Without this option the test will run
 for 1024 seconds or until the user types ctrl-c.
 .It Fl v
 The verbose option adds debugging output to the command.
 .It Fl E Ar expression
-This option can be used by those that have there own ideas
-on what formulas that you want to run. The expression given to
-the
+This option can be used by those that have their own ideas
+on what formulas they want to run.
+The expression given to the
 .Fl E
-option is a "formula". The formula can declare directly the PMC's by name
-or you can use an abbreviation %NNN. To find out the abbreviations
+option is a "formula".
+The formula can declare directly the PMCs by name
+or you can use an abbreviation %NNN.
+To find out the abbreviations
 on your system you may run the
 .Fl L
 option.
@@ -107,21 +115,25 @@ An example of a formula of your own migh
 "FP_ASSIST.ANY / INST_RETIRED.ANY_P" or using the abbreviations on a
 Haswell machine you would type
 .Fl E
-" %176 / %150". You must have spaces between each entry and
-you may use paraenthisis to prioritize the operators. Add (+), Subtract (-),
-Divide (/) and Multiplication (*) are supported. You may also introduce
-constant numbers as well. So for example you can do a standard efficency
+" %176 / %150".
+You must have spaces between each entry and
+you may use parentheses to prioritize the operators.
+Add (+), Subtract (-),
+Divide (/) and Multiplication (*) are supported.
+You may also introduce
+constant numbers.
+For example you can do a standard efficency
 test like
-.FL E
+.Fl E
 "UOPS_RETIRED.RETIRE_SLOTS / (4 * CPU_CLK_UNHALTED.THREAD_P)".
-
 .It Fl L
-This option will list all known PMC's and there abbreviation (%NNN).
+This option will list all known PMCs and their abbreviation (%NNN).
+.El
 .Sh SEE ALSO
 .Xr pmc 3 ,
 .Xr pmclog 3 ,
 .Xr hwpmc 4 ,
-.Xr pmcstat 8 ,
+.Xr pmcstat 8
 .Sh HISTORY
 The
 .Nm