jocamlprof(1) [debian man page]

JOCAMLPROF(1)						      General Commands Manual						     JOCAMLPROF(1)

NAME

       jocamlprof - The JoCaml profiler

SYNOPSIS

       jocamlprof [ -f dump-file ] [ -F text ] filename ...

DESCRIPTION

       The jocamlprof command prints execution counts gathered during the execution of a Objective Caml program instrumented with jocamlcp(1).

       It produces a source listing of the program modules given as arguments where execution counts have been inserted as comments. For instance,

       jocamlprof foo.ml

       prints  the  source  code  for the foo module, with comments indicating how many times the functions in this module have been called. Natu-
       rally, this information is accurate only if the source file has not been modified since the profiling execution took place.

OPTIONS

       -f dumpfile
	      Specifies an alternate dump file of profiling information.

       -F string
	      Specifies an additional string to be output with profiling information.  By default, jocamlprof(1) will annotate programs with  com-
	      ments of the form (* n *) where n is the counter value for a profiling point. With option -F s the annotation will be (* sn *)

       -impl filename
	      Compile the file filename as an implementation file, even if its extension is not .ml.

       -intf filename
	      Compile the file filename as an interface file, even if its extension is not .mli.

       -version
	      Print the version number of jocamlprof and exit.

       -help or --help
	      Display a short usage summary and exit.

SEE ALSO

       jocamlcp(1).
       The Objective Caml user's manual, chapter "Profiling".

																     JOCAMLPROF(1)

JOCAMLCP(1)						      General Commands Manual						       JOCAMLCP(1)

NAME

       Jocamlcp - The JoCaml profiling compiler

SYNOPSIS

       jocamlcp [ jocamlcp options ] [ -p flags ] filename ...

DESCRIPTION

       The  jocamlcp  command  is  a  front-end to jocamlc(1) that instruments the source code, adding code to record how many times functions are
       called, branches of conditionals are taken, ...	Execution of instrumented code produces an execution profile in the  file  ocamlprof.dump,
       which can be read using jocamlprof(1).

       jocamlcp accepts the same arguments and options as jocamlc(1).

OPTIONS

       In addition to the jocamlc(1) options, jocamlcp accepts the following option controlling the amount of profiling information:

       -p letters
	      The letters indicate which parts of the program should be profiled:

       a      all options

       f      function calls : a count point is set at the beginning of each function body

       i      if ... then ... else: count points are set in both then and else branches

       l      0 loops: a count point is set at the beginning of the loop body

       m      match branches: a count point is set at the beginning of the body of each branch of a pattern-matching

       t      try ... with branches: a count point is set at the beginning of the body of each branch of an exception catcher

       For instance, compiling with jocamlcp -pfilm profiles function calls, if ... then ... else ..., loops, and pattern matching.

       Calling jocamlcp(1) without the -p option defaults to -p fm meaning that only function calls and pattern matching are profiled.

       Note:  due  to the implementation of streams and stream patterns as syntactic sugar, it is hard to predict what parts of stream expressions
       and patterns will be profiled by a given flag.  To profile a program with streams, we recommend using jocamlcp -p a.

SEE ALSO

       jocamlc(1), jocamlprof(1).
       The Objective Caml user's manual, chapter "Profiling".

																       JOCAMLCP(1)