r240430 - Adding a title to appease the sphinx build bot.

Aaron Ballman aaron at aaronballman.com
Thu Jun 25 06:17:57 PDT 2015


On Wed, Jun 24, 2015 at 7:14 PM, Justin Bogner <mail at justinbogner.com> wrote:
> Aaron Ballman <aaron at aaronballman.com> writes:
>> Author: aaronballman
>> Date: Tue Jun 23 12:31:30 2015
>> New Revision: 240430
>>
>> URL: http://llvm.org/viewvc/llvm-project?rev=240430&view=rev
>> Log:
>> Adding a title to appease the sphinx build bot.
>
> This isn't actually sufficient - the bot's still failing because there
> are cross references into the attributes elsewhere in the docs. So now
> we get errors like:
>
>   clang/docs/AddressSanitizer.rst:128: WARNING: undefined label: langext-address_sanitizer (if the link has no caption the label must precede a section header)

That's very strange, I am unable to reproduce locally, though the
issue appears to be a valid one.

> Why don't we have a build target that generates this with tablegen and
> then generates the docs including that? That's really what the bot wants
> to test, no? AFAICT you currently have to run tablegen manually in order
> to generate a complete set of docs.

I agree, the generation of this file should be part of a build target.
However, I'm not certain how to make that magic work (for both of our
build systems). Ideally, there would not be a local
AttributeReference.rst, but it would be created as part of the
documentation build process. But that requires clang-tblgen to be
present, and the ability to generate the .rst file into the proper
location to build the docs.

~Aaron

>
>> Modified:
>>     cfe/trunk/docs/AttributeReference.rst
>>
>> Modified: cfe/trunk/docs/AttributeReference.rst
>> URL:
>> http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/AttributeReference.rst?rev=240430&r1=240429&r2=240430&view=diff
>> ==============================================================================
>> --- cfe/trunk/docs/AttributeReference.rst (original)
>> +++ cfe/trunk/docs/AttributeReference.rst Tue Jun 23 12:31:30 2015
>> @@ -7,3 +7,7 @@
>>    Please do not commit this file. The file exists for local testing
>>    purposes only.
>>    -------------------------------------------------------------------
>> +
>> +===================
>> +Attributes in Clang
>> +===================
>> \ No newline at end of file
>>
>>
>> _______________________________________________
>> cfe-commits mailing list
>> cfe-commits at cs.uiuc.edu
>> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits



More information about the cfe-commits mailing list