llvm-project/llvm/bindings/ocaml
Josh Berdine f4d156aed0 [NFC][OCaml] Reformat to clean up following CAMLprim removal
The removal of CAMLprim left the code in need of an application of
clang-format. There are various other changes made by clang-format
which it seems ought to be rolled together into this diff.

Differential Revision: https://reviews.llvm.org/D99477
2021-04-05 10:55:08 +01:00
..
all_backends [NFC][OCaml] Remove vestigial CAMLprim declarations 2021-04-05 10:55:08 +01:00
analysis [NFC][OCaml] Remove vestigial CAMLprim declarations 2021-04-05 10:55:08 +01:00
backends [NFC][OCaml] Remove vestigial CAMLprim declarations 2021-04-05 10:55:08 +01:00
bitreader [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
bitwriter [NFC][OCaml] Remove vestigial CAMLprim declarations 2021-04-05 10:55:08 +01:00
debuginfo [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
executionengine [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
irreader [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
linker [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
llvm [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
target [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
transforms [NFC][OCaml] Reformat to clean up following CAMLprim removal 2021-04-05 10:55:08 +01:00
.ocamlformat [OCaml] DebugInfo support for OCaml bindings 2021-03-17 10:15:56 +05:30
CMakeLists.txt [OCaml] DebugInfo support for OCaml bindings 2021-03-17 10:15:56 +05:30
README.txt [OCaml] DebugInfo support for OCaml bindings 2021-03-17 10:15:56 +05:30

README.txt

This directory contains LLVM bindings for the OCaml programming language
(http://ocaml.org).

Prerequisites
-------------

* OCaml 4.00.0+.
* ctypes 0.4+.
* oUnit 2+ (only required for tests).
* CMake (to build LLVM).

Building the bindings
---------------------

If all dependencies are present, the bindings will be built and installed
as a part of the default CMake configuration, with no further action.
They will only work with the specific OCaml compiler detected during the build.

The bindings can also be built out-of-tree, i.e. targeting a preinstalled
LLVM. To do this, configure the LLVM build tree as follows:

    $ cmake -DLLVM_OCAML_OUT_OF_TREE=TRUE \
            -DCMAKE_INSTALL_PREFIX=[Preinstalled LLVM path] \
            -DLLVM_OCAML_INSTALL_PATH=[OCaml install prefix] \
            [... any other options]

then build and install it as:

    $ make ocaml_all
    $ cmake -P bindings/ocaml/cmake_install.cmake