> On Jun 22, 2015, at 10:31 AM, Aaron Ballman <[email protected]> wrote:
>
> On Mon, Jun 22, 2015 at 1:06 PM, Douglas Gregor <[email protected]> wrote:
>> Author: dgregor
>> Date: Mon Jun 22 12:06:56 2015
>> New Revision: 240296
>>
>> URL: http://llvm.org/viewvc/llvm-project?rev=240296&view=rev
>> Log:
>> Document the nullability attributes.
>
> Thank you!
>
>>
>> Modified:
>> cfe/trunk/docs/AttributeReference.rst
>> cfe/trunk/include/clang/Basic/Attr.td
>> cfe/trunk/include/clang/Basic/AttrDocs.td
>>
>> Modified: cfe/trunk/docs/AttributeReference.rst
>
> Please do not commit changes to AttributeReference.rst directly. This
> file is automatically generated on the server (daily) from
> AttrDocs.td. It exists because we need it for folks who want to
> generate documentation locally.
>
> I think it's time to change the contents of this file to be nothing
> but a comment saying, "Please do not commit changes to this file", but
> the downside is that will kill off AttributeReference.html on the live
> site until the server generates the new documentation. I am starting
> to suspect that pain may be worth it, and I might do this task later
> tonight.
Neither of these workflows are intuitive for the developer. Why aren’t we
building AttributeReference.rst into the build directory as part of the
documentation build, as one would expect? Having to manually call clang-tblgen
to update AttributeReference.rst, then separately build the docs with Sphinx,
then avoid committing the changes… makes improving documentation harder than it
should be.
- Doug
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
