[CMake] [OCaml] Allow building OCaml bindings out of tree.

That is, add build system support for building the OCaml bindings
against preinstalled LLVM libraries. This is important for package
managers such as OPAM, because OCaml libraries need to be built
against a specific OCaml compiler installation.

llvm-svn: 280642

1 files changed, 29 insertions, 0 deletions

diff --git a/llvm/bindings/ocaml/README.txt b/llvm/bindings/ocaml/README.txt
new file mode 100644
index 00000000000..68216b6792a
--- /dev/null
+++ b/llvm/bindings/ocaml/README.txt
@@ -0,0 +1,29 @@
+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=[OCaml install prefix] \
+            [... any other options]
+
+then build and install it as:
+
+    $ make ocaml_all
+    $ cmake -P bindings/ocaml/cmake_install.cmake