hanchenye-llvm-project/llvm/bindings/ocaml
Chandler Carruth 2946cd7010 Update the file headers across all of the LLVM projects in the monorepo
to reflect the new license.

We understand that people may be surprised that we're moving the header
entirely to discuss the new license. We checked this carefully with the
Foundation's lawyer and we believe this is the correct approach.

Essentially, all code in the project is now made available by the LLVM
project under our new license, so you will see that the license headers
include that license only. Some of our contributors have contributed
code under our old license, and accordingly, we have retained a copy of
our old license notice in the top-level files in each project and
repository.

llvm-svn: 351636
2019-01-19 08:50:56 +00:00
..
all_backends Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
analysis Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
backends Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
bitreader Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
bitwriter Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
executionengine Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
irreader Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
linker Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
llvm Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
target Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
transforms Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
CMakeLists.txt
README.txt

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=[OCaml install prefix] \
            [... any other options]

then build and install it as:

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