[LLVMdev] Code documentation

Vladimir Prus ghost at cs.msu.su
Thu Apr 8 07:13:04 PDT 2004


Hello,
is there any documentation for LLVM codebase other than produced by doxygen?
The reason I'm asking is that doxygen docs are 
(1) not very complete at the moment, as lot of classes don't even have a 
description
(2) is generally not the best way to get high-level view of a big codebase.

As an example, consider this code:

     %tmp.1 = setgt int %i, 0
     br bool %tmp.1, label %then.0, label %else.0

It appears that Value* that corresponds to the %tmp.1 operand of the second 
instruction is actually a pointer to Instruction* which represents the first 
instruction.

This looks a nice design, given that all code is in SSA, but I've spend 
considerable time today before understanding it, because I first tried to 
look up a  ways to find the instruction which defines tmp.1, then looked for 
a method which returns destination of an instruction, and so on..

I realize all the developers must be busy, but some overview would be really 
good.

- Volodya




More information about the llvm-dev mailing list