[project @ 1996-07-25 20:43:49 by partain]
[ghc-hetmet.git] / ghc / docs / users_guide / prof-rts-options.lit
index 022d4e3..cdbe3ed 100644 (file)
@@ -9,7 +9,7 @@ what you want to profile (e.g., time and/or space), and how you wish
 the collected data to be reported.  You also may wish to set the
 sampling interval used in time profiling.
 
-Executive summary: \tr{./a.out +RTS -p} produces a time profile in
+Executive summary: \tr{./a.out +RTS -pT} produces a time profile in
 \tr{a.out.prof}; \tr{./a.out +RTS -hC} produces space-profiling
 info which can be mangled by \tr{hp2ps} and viewed with \tr{ghostview}
 (or equivalent).
@@ -23,13 +23,13 @@ Profiling runtime flags are passed to your program between the usual
 \index{-P<sort> RTS option (profiling)}
 \index{time profile}
 \index{serial time profile}
-The \tr{-p} option produces a standard {\em time profile} report.
+The \tr{-p?} option produces a standard {\em time profile} report.
 It is written into the file \pl{<program>}\tr{.prof}.
 
-The \tr{-P} option produces a more detailed report containing the
+The \tr{-P?} option produces a more detailed report containing the
 actual time and allocation data as well.  (Not used much.)
 
-The \tr{-P} option also produces {\em serial time-profiling}
+The \tr{-P?} option also produces {\em serial time-profiling}
 information, in the file \pl{<program>}\tr{.time}. This can be
 converted into a (somewhat unsatisfactory) PostScript graph using
 \tr{hp2ps} (see \Sectionref{hp2ps}).
@@ -64,10 +64,10 @@ The heap space profile may be broken down by different criteria:
 \item[\tr{-hG}:] cost centre group which produced the closure.
 \item[\tr{-hD}:] closure description --- a string describing the closure.
 \item[\tr{-hY}:] closure type --- a string describing the closure's type.
-\item[\tr{-hT<ints>,<start>}:] the time interval the closure was
-created. \tr{<ints>} specifies the no. of interval bands plotted
-(default 18) and \tr{<start>} the number of seconds after which the
-reported intervals start (default 0.0).
+%\item[\tr{-hT<ints>,<start>}:] the time interval the closure was
+%created. \tr{<ints>} specifies the no. of interval bands plotted
+%(default 18) and \tr{<start>} the number of seconds after which the
+%reported intervals start (default 0.0).
 \end{description}
 By default all live closures in the heap are profiled, but particular
 closures of interest can be selected (see below). 
@@ -107,14 +107,14 @@ Selects closures which are of one of the specified closure kinds.
 Valid closure kinds are \tr{CON} (constructor), \tr{FN} (manifest
 function), \tr{PAP} (partial application), \tr{BH} (black hole) and
 \tr{THK} (thunk).
-\item[\tr{-a<age>}:]
-\index{-a<age> RTS option (profiling)}
-Selects closures which have survived \pl{<age>} complete intervals.
+%\item[\tr{-a<age>}:]
+%\index{-a<age> RTS option (profiling)}
+%Selects closures which have survived \pl{<age>} complete intervals.
 \end{description}
 The space occupied by a closure will be reported in the heap profile
 if the closure satisfies the following logical expression:
 \begin{display}
-([-c] or [-m] or [-g]) and ([-d] or [-y] or [-k]) and [-a]
+([-c] or [-m] or [-g]) and ([-d] or [-y] or [-k]) %and [-a]
 \end{display}
 where a particular option is true if the closure (or its attached cost
 centre) is selected by the option (or the option is not specified).