Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debugging byte code and profiling native code documentation #6789

Closed
vicuna opened this issue Feb 20, 2015 · 1 comment
Closed

Debugging byte code and profiling native code documentation #6789

vicuna opened this issue Feb 20, 2015 · 1 comment

Comments

@vicuna
Copy link

vicuna commented Feb 20, 2015

Original bug ID: 6789
Reporter: william
Status: resolved (set by @damiendoligez on 2016-04-18T12:03:46Z)
Resolution: suspended
Priority: normal
Severity: minor
Version: 4.02.1
Category: documentation

Bug description

in ocamlbuild documentation, the section "18.3.20 Debugging byte code and profiling native code" could be a bit clearer.

"The preferred way of compiling code suitable for debugging with ocamldebug or profiling native code with ocamlprof is to use the appropriate target extensions, .d.byte for debugging or .p.native."
=>
"To compile code suitable for debugging with ocamldebug, use the target extension .d.byte. To compile code suitable for profiling with gprof, use the target extension .p.native"

"Please note that the byte-code profiler works in a wholly different way and is not supported by ocamlbuild."
=>
"Please note that the byte-code profiler ocamlprof works in a wholly different way and is not supported by ocamlbuild."

Furthermore, ocamlprof can be replaced if I have well understood by gprof -A. So it would be nice to add to the last comment :
"[...] is not supported by ocamlbuild. Use if possible the target .p.native along with gprof -A to insert information in source code".
But in this case, "true:debug" must be added in order for gprof -A to work. So I was wondering if ".p.profile" should also add debug tag...

@vicuna
Copy link
Author

vicuna commented Apr 18, 2016

Comment author: @damiendoligez

ocamlbuild is now a separate project. I've transferred this PR to ocaml/ocamlbuild#72

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant