search

harvard-acc / LLVM-Tracer

An LLVM pass to profile dynamic LLVM IR instructions and runtime values
Other
135 stars 35 forks source link

Detailed documentation request #14

Closed z-a-f closed 7 years ago

z-a-f commented 8 years ago

I think it would be very useful if there was detailed documentation for general users and for developers. Poking through the code to figure out the reasons behind every method is a little painful :smiling_imp:

xyzsam commented 7 years ago

Yes, I agree that documentation is lacking, but don't expect it to come all at once - we have many other commitments to attend to as well. We'll try to add more docs from time to time.

xyzsam commented 7 years ago

For those who were interested: I just completed a major refactor of LLVM-Tracer, which should make the code much more understandable, and lots of documentation has been added.