[cfe-dev] [RFC] Tutorial for Clang Analyzer Plugins

[Anna Zaks]

On Jan 7, 2013, at 4:12 PM, Anna Zaks <ganna at apple.com> wrote:

> 
> On Jan 7, 2013, at 4:01 PM, Jordan Rose <jordan_rose at apple.com> wrote:
> 
>> 
>> On Jan 7, 2013, at 14:00 , Anna Zaks <ganna at apple.com> wrote:
>> 
>>> 
>>> On Jan 7, 2013, at 12:50 PM, Daniel Dunbar <daniel at zuster.org> wrote:
>>>> 
>>>> It makes total sense to me to have the internal documentation browsable on the websites somewhere, and this is what we do for LLVM and Clang and all the other projects, so I see no reason for the analyzer to be different. Note that its only "exposed" as much as there is a URL for it. You can decide if and when you want to link to it from the website.
>>> 
>>> Makes sense.
>> 
>> This isn't exactly true in Sphinx, because the default mode becomes "include" instead of "exclude".
>> 
>> It probably does make sense to make the "Development" part of the analyzer site become equivalent to LLVM and Clang's "docs".
> 
> I am not sure I agree that everything/anything under "Development" tab should be in different format than the rest of the site.

We've discussed this more internally. It makes sense for the analyzer manual to be in the same format as the rest of the site. So unless the rest of the analyzer page gets converted to Sphinx, the manual should stay in HTMl format. 

Unfortunately, we do not have time for full Sphinx conversion. But would be glad if someone else would contribute the effort to do it.

Sam, I am going to review the tutorial in more detail soon.

Thanks,
Anna.

> 
>> This is where the current Checker Developer Manual lives (and thanks for working on that, Sam; I think I agree with Anna that we'd rather have one merged doc for now), and where some of the current internal stuff could go if it were cleaned up a bit more, but I think we'd want to help moderate that transition. (If you think we should move our text-file notes out of docs/ for now, we could do that too.)
>> 
>> Jordan
>> 
> 
> _______________________________________________
> cfe-dev mailing list
> cfe-dev at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20130108/35c59c0e/attachment.html>