[LLVM Doc] tblgen backends

Hi all!

There is doc about tglben backends:

http://llvm.org/docs/TableGen/BackEnds.html

May be should to add link at

https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works

I remember when I first met the LLVM it would be very useful.

Hi Daniil,

Those look great! I think it could be factored into the current docs,
so as to not duplicate the same information in other places, and I'd
love to see it in.

Are you volunteering for the job? :slight_smile:

cheers,
--renato

I agree, but I have no experience with LLVM doc.
The job is very simple: add link at page
https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
into doc page
http://llvm.org/docs/TableGen/BackEnds.html
But how I can do it?

That's not what I meant. There are some parts of that doc that are
redundant with what we have already on http://llvm.org/docs/TableGen/,
so just adding a link wouldn't help people that are reading them make
any sense of why we should redirect them to another, different but
slightly similar, doc.

What I meant was to add the *contents* of that doc (with the author's
permission) into our docs, by merging the contents and removing the
duplication.

About LLVM's docs, it's based on Sphinx (http://sphinx-doc.org/ or
http://lld.llvm.org/sphinx_intro.html) and this
(http://llvm.org/docs/SphinxQuickstartTemplate.html) should get you
going with LLVM docs. At the end, just submit your patch to the
llvm-commits list and if approved, it'll be merged.

cheers,
--renato

> The job is very simple: add link at page
>
How TableGen's DAGISel Backend Works · draperlaboratory/fracture Wiki · GitHub
> into doc page
> TableGen BackEnds — LLVM 18.0.0git documentation

That's not what I meant. There are some parts of that doc that are
redundant with what we have already on TableGen Overview — LLVM 18.0.0git documentation,
so just adding a link wouldn't help people that are reading them make
any sense of why we should redirect them to another, different but
slightly similar, doc.

What I meant was to add the *contents* of that doc (with the author's
permission) into our docs, by merging the contents and removing the
duplication.

That would be nice but that is a lot more effort, so much so that I would
consider it a separate effort to do so. For now I think that providing a
link under TableGen BackEnds — LLVM 18.0.0git documentation is a simple
way to connect developers looking for information with useful information.

-- Sean Silva

I agree, but I have no experience with LLVM doc.
The job is very simple: add link at page

How TableGen's DAGISel Backend Works · draperlaboratory/fracture Wiki · GitHub
into doc page
TableGen BackEnds — LLVM 18.0.0git documentation
But how I can do it?

As always, send a patch to llvm-commits (and feel free to CC me on it). See
docs/README.txt for how the content on llvm.org/docs relates to the docs/
directory.

-- Sean Silva

Maybe then a link from the index? A new session with "further reading"?

--renato

> That would be nice but that is a lot more effort, so much so that I would
> consider it a separate effort to do so. For now I think that providing a
> link under TableGen BackEnds — LLVM 18.0.0git documentation is a
simple
> way to connect developers looking for information with useful
information.

Maybe then a link from the index? A new session with "further reading"?

I don't think that's necessary. A person looking for information about the
DAGISel tablegen backend is going to be looking at
TableGen BackEnds — LLVM 18.0.0git documentation and so it makes sense
for them to find the relevant link there.

-- Sean Silva

ok