aboutsummaryrefslogtreecommitdiffhomepage
path: root/dev
diff options
context:
space:
mode:
Diffstat (limited to 'dev')
-rw-r--r--dev/doc/debugging.md (renamed from dev/doc/debugging.txt)17
1 files changed, 9 insertions, 8 deletions
diff --git a/dev/doc/debugging.txt b/dev/doc/debugging.md
index 86e0f0470..7e9373b29 100644
--- a/dev/doc/debugging.txt
+++ b/dev/doc/debugging.md
@@ -25,8 +25,9 @@ Debugging from Coq toplevel using Caml trace mechanism
Debugging from Caml debugger
============================
- Needs tuareg mode in Emacs
- Coq must be configured with -debug and -local (./configure -debug -local)
+ Requires [Tuareg mode](https://github.com/ocaml/tuareg) in Emacs.\
+ Coq must be configured with `-local` (`./configure -local`) and the
+ byte-code version of `coqtop` must have been generated with `make byte`.
1. M-x camldebug
2. give the binary name bin/coqtop.byte
@@ -68,14 +69,14 @@ Global gprof-based profiling
Per function profiling
======================
- 1. To profile function foo in file bar.ml, add the following lines, just
- after the definition of the function:
+ To profile function foo in file bar.ml, add the following lines, just
+ after the definition of the function:
let fookey = Profile.declare_profile "foo";;
let foo a b c = Profile.profile3 fookey foo a b c;;
- where foo is assumed to have three arguments (adapt using
- Profile.profile1, Profile. profile2, etc).
+ where foo is assumed to have three arguments (adapt using
+ Profile.profile1, Profile. profile2, etc).
- This has the effect to cumulate the time passed in foo under a
- line of name "foo" which is displayed at the time coqtop exits.
+ This has the effect to cumulate the time passed in foo under a
+ line of name "foo" which is displayed at the time coqtop exits.