[cfe-commits] r171379 - /cfe/trunk/docs/index.rst

[Jordan Rose]

Cool, LGTM.


On Jan 2, 2013, at 13:09 , Sean Silva <silvas at purdue.edu> wrote:

> How does r171409 look to you? I noticed that the latter 3 documents
> were naturally organized hierarchically under LanguageExtensions.rst
> (they were even already linked), so I put them under
> LanguageExtensions.rst's toctree instead of on the landing page.
> 
> -- Sean Silva
> 
> On Wed, Jan 2, 2013 at 11:33 AM, Jordan Rose <jordan_rose at apple.com> wrote:
>> Nice!
>> 
>> I would move the Language Extensions section up to "Using Clang as a Compiler". It's mostly user-facing rather than spec-like, and is probably the only source of documentation for some of these extensions; IMHO it shouldn't be relegated to the bottom of the list.
>> 
>> Jordan
>> 
>> 
>> On Jan 2, 2013, at 4:41 , Sean Silva <silvas at purdue.edu> wrote:
>> 
>>> Author: silvas
>>> Date: Wed Jan  2 06:41:24 2013
>>> New Revision: 171379
>>> 
>>> URL: http://llvm.org/viewvc/llvm-project?rev=171379&view=rev
>>> Log:
>>> docs: Reorganize landing page.
>>> 
>>> I clustered the docs by some intuitive/fuzzy notion of "similarity", and
>>> some reasonable categories seemed to materialize. I tried to give the
>>> clusters useful names, but you may want to take a look at the landing
>>> page (<http://clang.llvm.org/docs/> for the lazy) and share your
>>> thoughts.
>>> 
>>> I have to say, this small change really gives the docs a whole new life!
>>> It makes our documentation quite a bit easier to navigate and scope out.
>>> 
>>> Modified:
>>>   cfe/trunk/docs/index.rst
>>> 
>>> Modified: cfe/trunk/docs/index.rst
>>> URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/index.rst?rev=171379&r1=171378&r2=171379&view=diff
>>> ==============================================================================
>>> --- cfe/trunk/docs/index.rst (original)
>>> +++ cfe/trunk/docs/index.rst Wed Jan  2 06:41:24 2013
>>> @@ -9,29 +9,59 @@
>>> .. toctree::
>>>   :maxdepth: 1
>>> 
>>> -   LanguageExtensions
>>> -   LibASTMatchers
>>> -   LibTooling
>>> -   PCHInternals
>>> -   Tooling
>>> +   ReleaseNotes
>>> +
>>> +Using Clang as a Compiler
>>> +-------------------------
>>> +
>>> +.. toctree::
>>> +   :maxdepth: 1
>>> +
>>> +   UsersManual
>>>   AddressSanitizer
>>>   ThreadSanitizer
>>>   MemorySanitizer
>>> +
>>> +Using Clang as a Library
>>> +------------------------
>>> +
>>> +.. toctree::
>>> +   :maxdepth: 1
>>> +
>>> +   Tooling
>>> +   IntroductionToTheClangAST
>>> +   LibTooling
>>>   ClangPlugins
>>> +   RAVFrontendAction
>>> +   LibASTMatchersTutorial
>>> +   LibASTMatchers
>>>   ClangTools
>>>   HowToSetupToolingForLLVM
>>> -   IntroductionToTheClangAST
>>>   JSONCompilationDatabase
>>> -   LibASTMatchersTutorial
>>> -   PTHInternals
>>> -   RAVFrontendAction
>>> -   UsersManual
>>> -   AutomaticReferenceCounting
>>> +
>>> +Design Documents
>>> +----------------
>>> +
>>> +.. toctree::
>>> +   :maxdepth: 1
>>> +
>>>   InternalsManual
>>>   DriverInternals
>>> -   BlockLanguageSpec
>>> +   PTHInternals
>>> +   PCHInternals
>>> +
>>> +
>>> +Language Extensions and Specs
>>> +-----------------------------
>>> +
>>> +.. toctree::
>>> +   :maxdepth: 1
>>> +
>>> +   LanguageExtensions
>>>   ObjectiveCLiterals
>>> -   ReleaseNotes
>>> +   BlockLanguageSpec
>>> +   AutomaticReferenceCounting
>>> +
>>> 
>>> Indices and tables
>>> ==================
>>> 
>>> 
>>> _______________________________________________
>>> cfe-commits mailing list
>>> cfe-commits at cs.uiuc.edu
>>> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
>>