diff --git a/bindings/ocaml/Makefile.ocaml b/bindings/ocaml/Makefile.ocaml index a2a8b02eac7..62f65880693 100644 --- a/bindings/ocaml/Makefile.ocaml +++ b/bindings/ocaml/Makefile.ocaml @@ -1,4 +1,4 @@ -##===- tools/ml/Makefile -----------------------------------*- Makefile -*-===## +##===- bindings/ocaml/Makefile.ocaml -----------------------*- Makefile -*-===## # # The LLVM Compiler Infrastructure # @@ -7,10 +7,10 @@ # ##===----------------------------------------------------------------------===## # -# An ocaml library is a unique project type in the context of LLVM, so rules are +# An OCaml library is a unique project type in the context of LLVM, so rules are # here rather than in Makefile.rules. # -# Reference materials on installing ocaml libraries: +# Reference materials on installing OCaml libraries: # # https://fedoraproject.org/wiki/Packaging/OCaml # http://pkg-ocaml-maint.alioth.debian.org/ocaml_packaging_policy.txt diff --git a/bindings/ocaml/analysis/analysis_ocaml.c b/bindings/ocaml/analysis/analysis_ocaml.c index 97167055f70..91be2d3f642 100644 --- a/bindings/ocaml/analysis/analysis_ocaml.c +++ b/bindings/ocaml/analysis/analysis_ocaml.c @@ -1,4 +1,4 @@ -/*===-- analysis_ocaml.c - LLVM Ocaml Glue ----------------------*- C++ -*-===*\ +/*===-- analysis_ocaml.c - LLVM OCaml Glue ----------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *| diff --git a/bindings/ocaml/analysis/llvm_analysis.ml b/bindings/ocaml/analysis/llvm_analysis.ml index fc4d2037074..21088ab6ff4 100644 --- a/bindings/ocaml/analysis/llvm_analysis.ml +++ b/bindings/ocaml/analysis/llvm_analysis.ml @@ -1,4 +1,4 @@ -(*===-- llvm_analysis.ml - LLVM Ocaml Interface -----------------*- C++ -*-===* +(*===-- llvm_analysis.ml - LLVM OCaml Interface -----------------*- C++ -*-===* * * The LLVM Compiler Infrastructure * diff --git a/bindings/ocaml/analysis/llvm_analysis.mli b/bindings/ocaml/analysis/llvm_analysis.mli index 793f482e3c6..1a0af02b387 100644 --- a/bindings/ocaml/analysis/llvm_analysis.mli +++ b/bindings/ocaml/analysis/llvm_analysis.mli @@ -1,4 +1,4 @@ -(*===-- llvm_analysis.mli - LLVM Ocaml Interface ----------------*- C++ -*-===* +(*===-- llvm_analysis.mli - LLVM OCaml Interface ----------------*- C++ -*-===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Intermediate representation analysis. - This interface provides an ocaml API for LLVM IR analyses, the classes in + This interface provides an OCaml API for LLVM IR analyses, the classes in the Analysis library. *) (** [verify_module m] returns [None] if the module [m] is valid, and diff --git a/bindings/ocaml/bitreader/bitreader_ocaml.c b/bindings/ocaml/bitreader/bitreader_ocaml.c index ef72ce213d8..0264e73117d 100644 --- a/bindings/ocaml/bitreader/bitreader_ocaml.c +++ b/bindings/ocaml/bitreader/bitreader_ocaml.c @@ -1,4 +1,4 @@ -/*===-- bitwriter_ocaml.c - LLVM Ocaml Glue ---------------------*- C++ -*-===*\ +/*===-- bitwriter_ocaml.c - LLVM OCaml Glue ---------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| \*===----------------------------------------------------------------------===*/ diff --git a/bindings/ocaml/bitreader/llvm_bitreader.ml b/bindings/ocaml/bitreader/llvm_bitreader.ml index 8b9d01d8fb0..865208c1ec0 100644 --- a/bindings/ocaml/bitreader/llvm_bitreader.ml +++ b/bindings/ocaml/bitreader/llvm_bitreader.ml @@ -1,4 +1,4 @@ -(*===-- llvm_bitreader.ml - LLVM Ocaml Interface ----------------*- C++ -*-===* +(*===-- llvm_bitreader.ml - LLVM OCaml Interface ----------------*- C++ -*-===* * * The LLVM Compiler Infrastructure * diff --git a/bindings/ocaml/bitreader/llvm_bitreader.mli b/bindings/ocaml/bitreader/llvm_bitreader.mli index 573de5e9830..ff377b9bc99 100644 --- a/bindings/ocaml/bitreader/llvm_bitreader.mli +++ b/bindings/ocaml/bitreader/llvm_bitreader.mli @@ -1,4 +1,4 @@ -(*===-- llvm_bitreader.mli - LLVM Ocaml Interface ---------------*- C++ -*-===* +(*===-- llvm_bitreader.mli - LLVM OCaml Interface ---------------*- C++ -*-===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Bitcode reader. - This interface provides an ocaml API for the LLVM bitcode reader, the + This interface provides an OCaml API for the LLVM bitcode reader, the classes in the Bitreader library. *) exception Error of string diff --git a/bindings/ocaml/bitwriter/bitwriter_ocaml.c b/bindings/ocaml/bitwriter/bitwriter_ocaml.c index 53c93cbdfe9..a47f7003e7e 100644 --- a/bindings/ocaml/bitwriter/bitwriter_ocaml.c +++ b/bindings/ocaml/bitwriter/bitwriter_ocaml.c @@ -1,4 +1,4 @@ -/*===-- bitwriter_ocaml.c - LLVM Ocaml Glue ---------------------*- C++ -*-===*\ +/*===-- bitwriter_ocaml.c - LLVM OCaml Glue ---------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *| diff --git a/bindings/ocaml/bitwriter/llvm_bitwriter.ml b/bindings/ocaml/bitwriter/llvm_bitwriter.ml index 3e69a3cc8fb..fac85538dba 100644 --- a/bindings/ocaml/bitwriter/llvm_bitwriter.ml +++ b/bindings/ocaml/bitwriter/llvm_bitwriter.ml @@ -1,4 +1,4 @@ -(*===-- llvm_bitwriter.ml - LLVM Ocaml Interface ----------------*- C++ -*-===* +(*===-- llvm_bitwriter.ml - LLVM OCaml Interface ----------------*- C++ -*-===* * * The LLVM Compiler Infrastructure * @@ -7,7 +7,7 @@ * *===----------------------------------------------------------------------=== * - * This interface provides an ocaml API for the LLVM intermediate + * This interface provides an OCaml API for the LLVM intermediate * representation, the classes in the VMCore library. * *===----------------------------------------------------------------------===*) diff --git a/bindings/ocaml/bitwriter/llvm_bitwriter.mli b/bindings/ocaml/bitwriter/llvm_bitwriter.mli index ea9a87600a7..bb3e3b89456 100644 --- a/bindings/ocaml/bitwriter/llvm_bitwriter.mli +++ b/bindings/ocaml/bitwriter/llvm_bitwriter.mli @@ -1,4 +1,4 @@ -(*===-- llvm_bitwriter.mli - LLVM Ocaml Interface ---------------*- C++ -*-===* +(*===-- llvm_bitwriter.mli - LLVM OCaml Interface ---------------*- C++ -*-===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Bitcode writer. - This interface provides an ocaml API for the LLVM bitcode writer, the + This interface provides an OCaml API for the LLVM bitcode writer, the classes in the Bitwriter library. *) (** [write_bitcode_file m path] writes the bitcode for module [m] to the file at diff --git a/bindings/ocaml/executionengine/executionengine_ocaml.c b/bindings/ocaml/executionengine/executionengine_ocaml.c index 02e03060572..32f6c5907cc 100644 --- a/bindings/ocaml/executionengine/executionengine_ocaml.c +++ b/bindings/ocaml/executionengine/executionengine_ocaml.c @@ -1,4 +1,4 @@ -/*===-- executionengine_ocaml.c - LLVM Ocaml Glue ---------------*- C++ -*-===*\ +/*===-- executionengine_ocaml.c - LLVM OCaml Glue ---------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *| diff --git a/bindings/ocaml/executionengine/llvm_executionengine.ml b/bindings/ocaml/executionengine/llvm_executionengine.ml index ddb53bbb5af..b083b7d14e9 100644 --- a/bindings/ocaml/executionengine/llvm_executionengine.ml +++ b/bindings/ocaml/executionengine/llvm_executionengine.ml @@ -1,4 +1,4 @@ -(*===-- llvm_executionengine.ml - LLVM Ocaml Interface ----------*- C++ -*-===* +(*===-- llvm_executionengine.ml - LLVM OCaml Interface ----------*- C++ -*-===* * * The LLVM Compiler Infrastructure * diff --git a/bindings/ocaml/executionengine/llvm_executionengine.mli b/bindings/ocaml/executionengine/llvm_executionengine.mli index 0b06078bad8..a3e1da3bcbd 100644 --- a/bindings/ocaml/executionengine/llvm_executionengine.mli +++ b/bindings/ocaml/executionengine/llvm_executionengine.mli @@ -1,4 +1,4 @@ -(*===-- llvm_executionengine.mli - LLVM Ocaml Interface ---------*- C++ -*-===* +(*===-- llvm_executionengine.mli - LLVM OCaml Interface ---------*- C++ -*-===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** JIT Interpreter. - This interface provides an ocaml API for LLVM execution engine (JIT/ + This interface provides an OCaml API for LLVM execution engine (JIT/ interpreter), the classes in the ExecutionEngine library. *) exception Error of string diff --git a/bindings/ocaml/llvm/llvm.mli b/bindings/ocaml/llvm/llvm.mli index eb6c88355af..35a4957fb35 100644 --- a/bindings/ocaml/llvm/llvm.mli +++ b/bindings/ocaml/llvm/llvm.mli @@ -1,4 +1,4 @@ -(*===-- llvm/llvm.mli - LLVM Ocaml Interface -------------------------------===* +(*===-- llvm/llvm.mli - LLVM OCaml Interface ------------------------------===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Core API. - This interface provides an ocaml API for the LLVM intermediate + This interface provides an OCaml API for the LLVM intermediate representation, the classes in the VMCore library. *) diff --git a/bindings/ocaml/llvm/llvm_ocaml.c b/bindings/ocaml/llvm/llvm_ocaml.c index c984bd154cc..6de935ab107 100644 --- a/bindings/ocaml/llvm/llvm_ocaml.c +++ b/bindings/ocaml/llvm/llvm_ocaml.c @@ -1,4 +1,4 @@ -/*===-- llvm_ocaml.c - LLVM Ocaml Glue --------------------------*- C++ -*-===*\ +/*===-- llvm_ocaml.c - LLVM OCaml Glue --------------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *| diff --git a/bindings/ocaml/target/llvm_target.ml b/bindings/ocaml/target/llvm_target.ml index f4891e2b83b..2959f0cbf5e 100644 --- a/bindings/ocaml/target/llvm_target.ml +++ b/bindings/ocaml/target/llvm_target.ml @@ -1,4 +1,4 @@ -(*===-- llvm_target.ml - LLVM Ocaml Interface ------------------*- OCaml -*-===* +(*===-- llvm_target.ml - LLVM OCaml Interface ------------------*- OCaml -*-===* * * The LLVM Compiler Infrastructure * diff --git a/bindings/ocaml/target/llvm_target.mli b/bindings/ocaml/target/llvm_target.mli index ab9c5e49eab..807bda96cb7 100644 --- a/bindings/ocaml/target/llvm_target.mli +++ b/bindings/ocaml/target/llvm_target.mli @@ -1,4 +1,4 @@ -(*===-- llvm_target.mli - LLVM Ocaml Interface -----------------*- OCaml -*-===* +(*===-- llvm_target.mli - LLVM OCaml Interface -----------------*- OCaml -*-===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Target Information. - This interface provides an ocaml API for LLVM target information, + This interface provides an OCaml API for LLVM target information, the classes in the Target library. *) module Endian : sig diff --git a/bindings/ocaml/target/target_ocaml.c b/bindings/ocaml/target/target_ocaml.c index 62fe789a52e..86f8de023da 100644 --- a/bindings/ocaml/target/target_ocaml.c +++ b/bindings/ocaml/target/target_ocaml.c @@ -1,4 +1,4 @@ -/*===-- target_ocaml.c - LLVM Ocaml Glue ------------------------*- C++ -*-===*\ +/*===-- target_ocaml.c - LLVM OCaml Glue ------------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *| diff --git a/bindings/ocaml/transforms/ipo/ipo_ocaml.c b/bindings/ocaml/transforms/ipo/ipo_ocaml.c index 612015c099a..496dc15e8c5 100644 --- a/bindings/ocaml/transforms/ipo/ipo_ocaml.c +++ b/bindings/ocaml/transforms/ipo/ipo_ocaml.c @@ -1,4 +1,4 @@ -/*===-- ipo_ocaml.c - LLVM Ocaml Glue -------------------*- C++ -*-===*\ +/*===-- ipo_ocaml.c - LLVM OCaml Glue ---------------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *| diff --git a/bindings/ocaml/transforms/ipo/llvm_ipo.ml b/bindings/ocaml/transforms/ipo/llvm_ipo.ml index 1562d10ae16..e895c7a7895 100644 --- a/bindings/ocaml/transforms/ipo/llvm_ipo.ml +++ b/bindings/ocaml/transforms/ipo/llvm_ipo.ml @@ -1,4 +1,4 @@ -(*===-- llvm_ipo.mli - LLVM Ocaml Interface ------------*- OCaml -*-===* +(*===-- llvm_ipo.ml - LLVM OCaml Interface --------------------*- OCaml -*-===* * * The LLVM Compiler Infrastructure * @@ -7,59 +7,29 @@ * *===----------------------------------------------------------------------===*) -(** IPO Transforms. - - This interface provides an ocaml API for LLVM interprocedural optimizations, the - classes in the [LLVMIPO] library. *) - -(** See llvm::createAddArgumentPromotionPass *) external add_argument_promotion : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_argument_promotion" - -(** See llvm::createConstantMergePass function. *) external add_constant_merge : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_constant_merge" - -(** See llvm::createDeadArgEliminationPass function. *) external add_dead_arg_elimination : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_dead_arg_elimination" - -(** See llvm::createFunctionAttrsPass function. *) external add_function_attrs : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_function_attrs" - -(** See llvm::createFunctionInliningPass function. *) external add_function_inlining : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_function_inlining" - -(** See llvm::createGlobalDCEPass function. *) external add_global_dce : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_global_dce" - -(** See llvm::createGlobalOptimizerPass function. *) external add_global_optimizer : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_global_optimizer" - -(** See llvm::createIPConstantPropagationPass function. *) external add_ipc_propagation : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_ipc_propagation" - -(** See llvm::createPruneEHPass function. *) external add_prune_eh : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_prune_eh" - -(** See llvm::createIPSCCPPass function. *) external add_ipsccp : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_ipsccp" - -(** See llvm::createInternalizePass function. *) external add_internalize : [ | `Module ] Llvm.PassManager.t -> bool -> unit = "llvm_add_internalize" - -(** See llvm::createStripDeadPrototypesPass function. *) external add_strip_dead_prototypes : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_strip_dead_prototypes" - -(** See llvm::createStripSymbolsPass function. *) external add_strip_symbols : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_strip_symbols" diff --git a/bindings/ocaml/transforms/ipo/llvm_ipo.mli b/bindings/ocaml/transforms/ipo/llvm_ipo.mli index 636103d4f8c..68f7c0e6cb8 100644 --- a/bindings/ocaml/transforms/ipo/llvm_ipo.mli +++ b/bindings/ocaml/transforms/ipo/llvm_ipo.mli @@ -1,4 +1,4 @@ -(*===-- llvm_ipo.mli - LLVM Ocaml Interface ------------*- OCaml -*-===* +(*===-- llvm_ipo.mli - LLVM OCaml Interface -------------------*- OCaml -*-===* * * The LLVM Compiler Infrastructure * @@ -9,13 +9,13 @@ (** IPO Transforms. - This interface provides an ocaml API for LLVM interprocedural optimizations, the + This interface provides an OCaml API for LLVM interprocedural optimizations, the classes in the [LLVMIPO] library. *) (** See llvm::createAddArgumentPromotionPass *) external add_argument_promotion : [ | `Module ] Llvm.PassManager.t -> unit = - "llvm_add_argument_promotion" + (** See llvm::createConstantMergePass function. *) external add_constant_merge : [ | `Module ] Llvm.PassManager.t -> unit = "llvm_add_constant_merge" diff --git a/bindings/ocaml/transforms/scalar/llvm_scalar_opts.ml b/bindings/ocaml/transforms/scalar/llvm_scalar_opts.ml index 93ab1de2582..d856c0f1b2c 100644 --- a/bindings/ocaml/transforms/scalar/llvm_scalar_opts.ml +++ b/bindings/ocaml/transforms/scalar/llvm_scalar_opts.ml @@ -1,4 +1,4 @@ -(*===-- llvm_scalar_opts.ml - LLVM Ocaml Interface -------------*- OCaml -*-===* +(*===-- llvm_scalar_opts.ml - LLVM OCaml Interface -------------*- OCaml -*-===* * * The LLVM Compiler Infrastructure * diff --git a/bindings/ocaml/transforms/scalar/llvm_scalar_opts.mli b/bindings/ocaml/transforms/scalar/llvm_scalar_opts.mli index 121b3761282..ea2e4a9113c 100644 --- a/bindings/ocaml/transforms/scalar/llvm_scalar_opts.mli +++ b/bindings/ocaml/transforms/scalar/llvm_scalar_opts.mli @@ -1,4 +1,4 @@ -(*===-- llvm_scalar_opts.mli - LLVM Ocaml Interface ------------*- OCaml -*-===* +(*===-- llvm_scalar_opts.mli - LLVM OCaml Interface ------------*- OCaml -*-===* * * The LLVM Compiler Infrastructure * @@ -9,7 +9,7 @@ (** Scalar Transforms. - This interface provides an ocaml API for LLVM scalar transforms, the + This interface provides an OCaml API for LLVM scalar transforms, the classes in the [LLVMScalarOpts] library. *) (** See the [llvm::createConstantPropogationPass] function. *) diff --git a/bindings/ocaml/transforms/scalar/scalar_opts_ocaml.c b/bindings/ocaml/transforms/scalar/scalar_opts_ocaml.c index 7047ec04c74..51e966c3376 100644 --- a/bindings/ocaml/transforms/scalar/scalar_opts_ocaml.c +++ b/bindings/ocaml/transforms/scalar/scalar_opts_ocaml.c @@ -1,4 +1,4 @@ -/*===-- scalar_opts_ocaml.c - LLVM Ocaml Glue -------------------*- C++ -*-===*\ +/*===-- scalar_opts_ocaml.c - LLVM OCaml Glue -------------------*- C++ -*-===*\ |* *| |* The LLVM Compiler Infrastructure *| |* *| @@ -7,7 +7,7 @@ |* *| |*===----------------------------------------------------------------------===*| |* *| -|* This file glues LLVM's ocaml interface to its C interface. These functions *| +|* This file glues LLVM's OCaml interface to its C interface. These functions *| |* are by and large transparent wrappers to the corresponding C functions. *| |* *| |* Note that these functions intentionally take liberties with the CAMLparamX *|