ghc/docs/users_guide/ticky.lit

   1 %************************************************************************
   2 %*                                                                      *
   3 \section[ticky-ticky]{Using ``ticky-ticky'' profiling (for implementors)}
   4 \index{ticky-ticky profiling (implementors)}
   5 %*                                                                      *
   6 %************************************************************************
   7
   8 (ToDo: document properly.)
   9
  10 It is possible to compile Glasgow Haskell programs so that they will
  11 count lots and lots of interesting things, e.g., number of updates,
  12 number of data constructors entered, etc., etc.  We call this
  13 ``ticky-ticky'' profiling,\index{ticky-ticky profiling}%
  14 \index{profiling, ticky-ticky} because that's the sound a Sun4 makes
  15 when it is running up all those counters ({\em slowly}).
  16
  17 Ticky-ticky profiling is mainly intended for implementors; it is quite
  18 separate from the main ``cost-centre'' profiling system, intended for
  19 all users everywhere.
  20
  21 To be able to use ticky-ticky profiling, you will need to have built
  22 appropriate libraries and things when you made the system.  See
  23 ``Customising what libraries to build,'' in the installation guide.
  24
  25 To get your compiled program to spit out the ticky-ticky numbers, use
  26 a \tr{-r} RTS option\index{-r RTS option}.