<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Mon, Feb 10, 2014 at 11:28 AM, Aaron Ballman <span dir="ltr"><<a href="mailto:aaron@aaronballman.com" target="_blank">aaron@aaronballman.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">(Removing llvm-admin since this doesn't concern them.)<br>
<div class=""><br>
On Mon, Feb 10, 2014 at 2:21 PM, Reid Kleckner <<a href="mailto:rnk@google.com">rnk@google.com</a>> wrote:<br>
> I'm conflicted about this.  The less time I spend editing .td files, the<br>
> happier I am.  Vim has reasonable support for highlighting and editting rst<br>
> out of the box, and I'd rather edit full text in that directly.<br>
><br>
> We're pretty good at keeping LLVM's LangRef.rst up to date through code<br>
> review.  Could we use the same approach with something in<br>
> docs/AttributesReference.rst, or do people think it would quickly become<br>
> stale?<br>
<br>
</div>We could, but I believe this approach is an improvement. For starters,<br>
it's a way that we can *require* attributes to have some documentation<br>
which is a drastic improvement over the LangRef.rst approach (at least<br>
as far as users are concerned). Also, there are things we can<br>
automatically generate for attributes which would require duplicated<br>
effort if it was done manually (such as what syntaxes are supported,<br>
what subjects the attribute can appertain to, etc). The declarative<br>
nature of the attribute tablegen lends itself nicely to this sort of<br>
automation.<br>
<br>
Honestly, I think the benefits are significant enough to warrant this approach.<br></blockquote><div><br></div><div>I'm OK with repeating the complete set of attribute names once in the documentation, but doing a nice pretty printing of all the spellings seems like a nice win that I hadn't thought of.</div>
</div></div></div>