[llvm-commits] [PATCH] Convert ProgrammersManual.html to reST

Sean Silva silvas at purdue.edu
Sun Dec 2 15:17:03 PST 2012


Hi Alexander, thanks for helping out with the conversion!

This looks pretty good. I think you have overused the :raw-html: role
a bit too much. While it's nice to preserve the original formatting in
the generated output, it generally is not worth destroying the
readability of the document in source form. Another problem with
:raw-html: is that there are plans down the road (far down the road)
to eventually render all of the docs into a LaTeX PDF distributed with
each release, so obviously HTML-specific things are not very friendly
to that.

So if you could remove the uses of :raw-html: the document looks
pretty much ready to be committed (there are a couple small things
that I can fix up later). For links to doxygen, you can just put
"(`doxygen <http://...>`_)" after the thing instead of making the
thing a link itself.

Also, your label `.. _Function:` clashes with one defined in
BitCodeFormat.rst. You should choose a different name for it.

-- Sean Silva



More information about the llvm-commits mailing list