[llvm] r196661 - Remove the notion of primitive types.

Rafael EspĂ­ndola rafael.espindola at gmail.com
Tue Dec 10 05:41:18 PST 2013


On 9 December 2013 23:59, Sean Silva <silvas at purdue.edu> wrote:
>  .. contents::
>     :local:
> -   :depth: 3
> +   :depth: 4
>
> Please revert this part of the patch. It makes the table of contents
> basically unreadable. (It causes each instruction/intrinsic to have a
> "Syntax", "Semantics", "Arguments", ... beneath it which severely bloats the
> ToC).

Yes, it would be nice to not have those on the TOC.

> For now, you can unnest the Single Value, Label, Metadata, Aggregate from
> under First Class, and have First Class just contain a list of all the first
> class types, with links to them.

But I really don't think this is the right solution. We should keep
the same hierarchy as Type.h, and that is not a balanced tree.

> In the long run, the "Syntax", "Semantics", ... should probably be changed
> to not use section divisions for labeling. I'm looking perhaps at doing
> something like CMake does (e.g.
> <http://cmake.org/gitweb?p=cmake.git;a=tree;f=Help/variable;h=7e7a7c6f3e9f452d0e0e7c58e1f23c28367d7e18;hb=HEAD>),
> which helps keep things nicely factored (a Sphinx plugin then does a bit of
> touchup to join everything together into the final docs). Alternatively, we
> could use reST's field lists
> <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists>
> with a Sphinx plugin that recognizes and handles them nicely.

I will give field lists a try (without a plugin).

Cheers,
Rafael



More information about the llvm-commits mailing list