[LLVMdev] Extracting libmachine from libcodegen (bug 1121)

[Sean Silva]

On Thu, Sep 5, 2013 at 8:15 PM, Ken Dyck <kd at kendyck.com> wrote:

> Hi,
>
> One of the long-standing code clean-up bugs in Bugzilla is to extract
> the Machine* code from the CodeGen library into a separate one, on
> which CodeGen depends (
> http://llvm.org/bugs/show_bug.cgi?id=1121).
>
> I'd like to start working on this. The general approach I'm planning to
> take is:
>
> 1. Identify which code to move.
> 2. Eliminate all dependencies that the Machine code has on the CodeGen
> code (details to be fleshed out on llvmdev as they are encountered).
> 3. Create a library project for the Machine code
> 4. Move the code to the new library.
>
> Do you have any concerns about the feasibility this approach?
>

I'd like to suggest something for #1: documenting what's already there. The
doxygen documentation is ok-ish, but there really needs to be real,
long-form documentation in our Sphinx docs (i.e. docs/) about what
functionality is there and especially what role it plays in the compiler
(there's probably more than one document's worth to write about). The
Sphinx quickstart template should have most of the info you need to get up
and running <http://llvm.org/docs/SphinxQuickstartTemplate.html>, but don't
hesitate to email llvmdev and CC me personally if you have any other
questions about the Sphinx docs.

AFAIK the only documentation we have about the Machine* code is the short
blurbs about a couple classes in <
http://llvm.org/docs/CodeGenerator.html#machine-code-description-classes>.

Especially the serialization work will benefit greatly from something akin
to a "MachineLangRef".

-- Sean Silva
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20130906/40336f00/attachment.html>