[PATCH] D31025: [Docs] Add tablegen backend for target opcode documentatio

Tanya Lattner via llvm-commits llvm-commits at lists.llvm.org
Wed Jan 3 08:39:46 PST 2018


I have a script that seems to be working (not on by default yet). You can see an example here of the output: http://llvm.org/docs/AArch64Instructions.html

Because this tool relies on tablegen, it is run once a night with the tool being built first and then the documentation. This is what we do for the Clang Command Line attribute documentation that relies on clang-tablegen. I’m open to other suggestions.

Also, it does currently generate warnings:
/opt/opcode_docs/src/llvm/docs/AArch64Instructions.rst:: WARNING: document isn't included in any toctree

Lastly, the script will email the www-scripts mailing list on error, but if you want it to also email you, please let me know.

-Tanya

> On Nov 21, 2017, at 3:22 AM, Oliver Stannard <oliver.stannard at arm.com> wrote:
> 
> Hi Tanya,
> 
> The table-gen patch for this is now committed, so would you be able to update the scripts needed to put this documentation on llvm.org?
> 
> I've attached the script (make_docs.sh) that I use to generate the RST files, which is run from the LLVM build directory, and assumes the source tree is at ../llvm.
> 
> I've also put a patch up for review at https://reviews.llvm.org/D40292 to add the necessary table-of-contents entries for this.
> 
> Oliver 
> 
>> -----Original Message-----
>> From: Oliver Stannard
>> Sent: 08 May 2017 09:59
>> To: Tanya Lattner;
>> reviews+D31025+public+4f46a0ac40e19178 at reviews.llvm.org
>> Cc: James Molloy; anton at korobeynikov.info;
>> bjorn.a.pettersson at ericsson.com; mgorny at gentoo.org; llvm-
>> commits at lists.llvm.org; nd
>> Subject: RE: [PATCH] D31025: [Docs] Add tablegen backend for target
>> opcode documentatio
>> 
>> Ping
>> 
>>> -----Original Message-----
>>> From: Tanya Lattner [mailto:tanyalattner at llvm.org]
>>> Sent: 07 April 2017 00:05
>>> To: reviews+D31025+public+4f46a0ac40e19178 at reviews.llvm.org
>>> Cc: Oliver Stannard; James Molloy; anton at korobeynikov.info;
>>> bjorn.a.pettersson at ericsson.com; mgorny at gentoo.org; llvm-
>>> commits at lists.llvm.org
>>> Subject: Re: [PATCH] D31025: [Docs] Add tablegen backend for target
>> opcode
>>> documentatio
>>> 
>>> My apologizes as I was preparing for EuroLLVM and traveling.. and then
>> had
>>> a family vacation right after. I’ll address this over the next couple
>>> days.
>>> 
>>> -Tanya
>>> 
>>>> On Mar 31, 2017, at 3:25 AM, Oliver Stannard via Phabricator
>>> <reviews at reviews.llvm.org> wrote:
>>>> 
>>>> olista01 added a comment.
>>>> 
>>>> Ping
>>>> 
>>>> 
>>>> Repository:
>>>> rL LLVM
>>>> 
>>>> https://reviews.llvm.org/D31025
>>>> 
>>>> 
>>>> 
> 
> <make_docs.sh>



More information about the llvm-commits mailing list