plasma-umass / coz

Coz: Causal Profiling
Other
4.03k stars 160 forks source link

Improve developer's first experience #187

Closed kormang closed 2 years ago

kormang commented 2 years ago

When new developers try to use coz to profile their programs, and find out that coz has some problems it is difficult to start debugging coz itself.

First there is issue with linker failing to find symbol as reported in #181 and also resolved in #185 . So it might be good to add that trick to build instructions in README.

Also build instructions suggest creating build directory in the repository directory. That is OK, but it would be OK, then, to put that directory to gitignore.

Also it seems like code that looks for libcoz.so in coz's main python script, is outdated and doesn't quite work well with CMake generating build directory and putting all output files in that directory. So adding build directory to search path for libcoz.so, makes it much easier for new developers to start debugging coz, after building it from source.

So this PR basically aligns code with README instructions and vice versa.

kormang commented 2 years ago

Hello!

Thank you for open sourcing such a magic tool. It is awesome, it works magically. And sometimes it also fails. So I'm working hard to fix few things, and I must these changes would make my life much easier, if they were already there.

I hope the project is still alive, and that the work I'm putting into new PRs won't be in vain.

emeryberger commented 2 years ago

LGTM, thanks! PRs always welcome!