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

[Marshall Clow]

On Apr 19, 2012, at 2:44 AM, Manuel Klimek wrote:

> Attached is a first version of Tooling.html for review. The links will
> be updated as I write the rest of the docs.
> 
> Btw, what's the review process for docs? :)

I don't know, but you've got some errors in your docs, in the libTooling section.

> Canonical examples of when to use LibTooling:
> 
> 	• a simple syntax checker
> 	• refactoringh tools

RefactoringH ? Is that a german thing? ;-)

> 
> Use LibTooling when you...
> 
> 	• want to run tools over a single file, or a specific subset of files, independently of the build system
> 	• want full control over the Clang AST
> 
> Do not use Clang Plugins when you...
> 
> 	• want to run as part of the build triggered by dependency changes
> 	• want a stable high-level interface
> 	• do not want to write your tools in C++

"Do not use Clang Plugins"… ?
Copy/paste error?


-- Marshall

Marshall Clow     Idio Software   <mailto:mclow.lists at gmail.com>

A.D. 1517: Martin Luther nails his 95 Theses to the church door and is promptly moderated down to (-1, Flamebait).
        -- Yu Suzuki