[cfe-dev] [PATCH] Tooling docs - structuring proposal

[Manuel Klimek]

On Mon, Apr 16, 2012 at 10:29 PM, Stephen Kelly <steveire at gmail.com> wrote:
> Manuel Klimek wrote:
>
>> I'm working on documenting stuff around the general tooling efforts
>> that clang offers.
>> ind attached a crude first draft of where I want to start for people
>> who have no idea what they should look into.
>>
>> The general structure I imagine is:
>> Tooling.html - basically the attached document, explaining what to use
>> when, linking to the other docs
>>
>> ClangPlugins.html - tutorial on how to write a clang plugin,
>> eventually leading to FrontendAction.html
>> LibTooling.html - tutorial on how to write clang standalone tools,
>> also leading to FrontendAction.html
>> (LibClang.html would fit here, but I'm not in a position to write it ;)
>>
>> FrontendAction.html - explains how to create your own FrontendAction
>> to use in a plugin or clang tool, possibly including the use of the
>> RAV (not sure whether we should split that out), linking to
>> ClangAST.html for reference
>>
>> ClangAST.html - a more generic introduction to the Clang AST, what it
>> looks like on a high level, the basic nodes it's made up from, how to
>> dig into the docs etc
>>
>> If nobody objects I'll just go on writing initial rough draft versions...
>>
>> Thoughts?
>> /Manuel
>
>
> Did any more documentation along these lines ever get written?

Not yet, last week I was pretty busy with the conference :) But I'm
working on it - it's high on my priority list.

Cheers,
/Manuel