We need more examples code and comments.

[lanistor]

When started to learn LLVM, i found the greatest resistance preventing me from moving forward, is the lacking of example code and code comments. The current code and comments only provide very little help, even a simple API will cost nearly half a day to found how to use it, and it always be resolved from google and stackoverflow, not from source code, not from official website.
So have you planed to provide more code comments and example code?

[dcci]

@vifird Do you have any specific example in mind?

[lanistor]

Here are my cases:

1. About getelementptr
   I know how to write getelementptr instruction by hand, but there seems no example to show how to generate this instruction with struct type, it cost me nearly a whole day to find the IRBuilder::CreateInBoundsGEP and the usage.
2. About link c++ function
   All i found about linking c++ function, is addGlobalMapping from stackoverflow, but i cannot use it in version 10, thanks for this answer, i got LLJIT::defineAbsolute, but still blocked by using it.

More questions will appear, i will supplement then.

While, when i learn flutter frame, i can nearly get all i want from source code and code comments, that‘s really convenient and high-authority.

[bwendling]

This doc should give you a very good understanding of the basic layout and common data structures used by LLVM.

http://llvm.org/docs/ProgrammersManual.html

[lanistor]

@gwelymernans Had readed it already, helpless. The document tells you how to design you project, but doesn't tell you how to write your code with it.

[joker-eph]

In general, I think the Kaleidoscope tutorial is a good starting point to have a good tour of LLVM, but it isn't intended to be exhaustive in terms of visiting all the possible APIs though.

[lanistor]

Yeah, example code may be the fast way for learning and using the huge number of APIs.