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

[Oliver Stannard via llvm-commits]

Hi Tanya,

I've attached a script, make_docs.sh, which I've been using to build the documentation. It should be run in the LLVM build dir, and assumes that the LLVM source is at ../llvm.

I've also attached a patch which adds links to the top-level table of contents, which is needed for sphinx to process them. This puts links to them in the "Subsystem Documentation" section, which looks like the right place for them (since this is intended to be useful to LLVM developers).

Oliver

> -----Original Message-----
> From: Tanya Lattner [mailto:tanyalattner at llvm.org]
> Sent: 16 March 2017 23:18
> To: reviews+D31025+public+4f46a0ac40e19178 at reviews.llvm.org
> Cc: Oliver Stannard; James Molloy; to: anton at korobeynikov.info;
> mgorny at gentoo.org; llvm-commits at lists.llvm.org; junbuml at codeaurora.org
> Subject: Re: [PATCH] D31025: [Docs] Add tablegen backend for target opcode
> documentatio
> 
> There are a bunch of scripts that run on the server to generate
> documentation (sphinx, doxygen, and one uses clang table gen).
> 
> I have not examined this diff in detail, can you give me a high level
> summary of what command(s) are used to generate documentation and where
> that documentation would exist on llvm.org?
> 
> Thanks,
> Tanya
> 
> 
> > On Mar 16, 2017, at 2:47 AM, Oliver Stannard via Phabricator
> <reviews at reviews.llvm.org> wrote:
> >
> > olista01 created this revision.
> > Herald added a subscriber: mgorny.
> >
> > This is a tablegen backend to generate documentation for the opcodes
> that exist for each target. For each opcode, it lists the assembly string,
> the names and types of all operands, and the flags and predicates that
> apply to the opcode.
> >
> > As far as I can tell, the current table-generated documentation is built
> for llvm.org by some method external to the CMake scripts. What need doing
> to get this documentation visible on llvm.org?
> >
> >
> > Repository:
> >  rL LLVM
> >
> > https://reviews.llvm.org/D31025
> >
> > Files:
> >  utils/TableGen/CMakeLists.txt
> >  utils/TableGen/InstrDocsEmitter.cpp
> >  utils/TableGen/TableGen.cpp
> >  utils/TableGen/TableGenBackends.h
> >
> > <D31025.91979.patch>

-------------- next part --------------
A non-text attachment was scrubbed...
Name: make_docs.sh
Type: application/octet-stream
Size: 456 bytes
Desc: make_docs.sh
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20170320/8ea78e0d/attachment.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0002-TOC-entries-for-target-opcode-documentation.patch
Type: application/octet-stream
Size: 1865 bytes
Desc: 0002-TOC-entries-for-target-opcode-documentation.patch
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20170320/8ea78e0d/attachment-0001.obj>