OCaml bindings: formatting
authorSylvestre Ledru <sylvestre@debian.org>
Fri, 1 Nov 2013 00:26:01 +0000 (00:26 +0000)
committerSylvestre Ledru <sylvestre@debian.org>
Fri, 1 Nov 2013 00:26:01 +0000 (00:26 +0000)
This commit only changes comments and documentation in OCaml bindings. The official name of the language is OCaml, and the usage is now consistent.

Patch by Peter Zotov

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@193836 91177308-0d34-0410-b5e6-96231b3b80d8

24 files changed:
bindings/ocaml/Makefile.ocaml
bindings/ocaml/analysis/analysis_ocaml.c
bindings/ocaml/analysis/llvm_analysis.ml
bindings/ocaml/analysis/llvm_analysis.mli
bindings/ocaml/bitreader/bitreader_ocaml.c
bindings/ocaml/bitreader/llvm_bitreader.ml
bindings/ocaml/bitreader/llvm_bitreader.mli
bindings/ocaml/bitwriter/bitwriter_ocaml.c
bindings/ocaml/bitwriter/llvm_bitwriter.ml
bindings/ocaml/bitwriter/llvm_bitwriter.mli
bindings/ocaml/executionengine/executionengine_ocaml.c
bindings/ocaml/executionengine/llvm_executionengine.ml
bindings/ocaml/executionengine/llvm_executionengine.mli
bindings/ocaml/llvm/llvm.mli
bindings/ocaml/llvm/llvm_ocaml.c
bindings/ocaml/target/llvm_target.ml
bindings/ocaml/target/llvm_target.mli
bindings/ocaml/target/target_ocaml.c
bindings/ocaml/transforms/ipo/ipo_ocaml.c
bindings/ocaml/transforms/ipo/llvm_ipo.ml
bindings/ocaml/transforms/ipo/llvm_ipo.mli
bindings/ocaml/transforms/scalar/llvm_scalar_opts.ml
bindings/ocaml/transforms/scalar/llvm_scalar_opts.mli
bindings/ocaml/transforms/scalar/scalar_opts_ocaml.c

index a2a8b02..62f6588 100644 (file)
@@ -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
index 9716705..91be2d3 100644 (file)
@@ -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 *|
index fc4d203..21088ab 100644 (file)
@@ -1,4 +1,4 @@
-(*===-- llvm_analysis.ml - LLVM Ocaml Interface -----------------*- C++ -*-===*
+(*===-- llvm_analysis.ml - LLVM OCaml Interface -----------------*- C++ -*-===*
  *
  *                     The LLVM Compiler Infrastructure
  *
index 793f482..1a0af02 100644 (file)
@@ -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
index ef72ce2..0264e73 100644 (file)
@@ -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.    *|
 |*                                                                            *|
 \*===----------------------------------------------------------------------===*/
index 8b9d01d..865208c 100644 (file)
@@ -1,4 +1,4 @@
-(*===-- llvm_bitreader.ml - LLVM Ocaml Interface ----------------*- C++ -*-===*
+(*===-- llvm_bitreader.ml - LLVM OCaml Interface ----------------*- C++ -*-===*
  *
  *                     The LLVM Compiler Infrastructure
  *
index 573de5e..ff377b9 100644 (file)
@@ -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
index 53c93cb..a47f700 100644 (file)
@@ -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 *|
index 3e69a3c..fac8553 100644 (file)
@@ -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.
  *
  *===----------------------------------------------------------------------===*)
index ea9a876..bb3e3b8 100644 (file)
@@ -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
index 02e0306..32f6c59 100644 (file)
@@ -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 *|
index ddb53bb..b083b7d 100644 (file)
@@ -1,4 +1,4 @@
-(*===-- llvm_executionengine.ml - LLVM Ocaml Interface ----------*- C++ -*-===*
+(*===-- llvm_executionengine.ml - LLVM OCaml Interface ----------*- C++ -*-===*
  *
  *                     The LLVM Compiler Infrastructure
  *
index 0b06078..a3e1da3 100644 (file)
@@ -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
index eb6c883..35a4957 100644 (file)
@@ -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. *)
 
 
index c984bd1..6de935a 100644 (file)
@@ -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 *|
index f4891e2..2959f0c 100644 (file)
@@ -1,4 +1,4 @@
-(*===-- llvm_target.ml - LLVM Ocaml Interface ------------------*- OCaml -*-===*
+(*===-- llvm_target.ml - LLVM OCaml Interface ------------------*- OCaml -*-===*
  *
  *                     The LLVM Compiler Infrastructure
  *
index ab9c5e4..807bda9 100644 (file)
@@ -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
index 62fe789..86f8de0 100644 (file)
@@ -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 *|
index 612015c..496dc15 100644 (file)
@@ -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 *|
index 1562d10..e895c7a 100644 (file)
@@ -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"
index 636103d..68f7c0e 100644 (file)
@@ -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"
index 93ab1de..d856c0f 100644 (file)
@@ -1,4 +1,4 @@
-(*===-- llvm_scalar_opts.ml - LLVM Ocaml Interface -------------*- OCaml -*-===*
+(*===-- llvm_scalar_opts.ml - LLVM OCaml Interface -------------*- OCaml -*-===*
  *
  *                     The LLVM Compiler Infrastructure
  *
index 121b376..ea2e4a9 100644 (file)
@@ -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. *)
index 7047ec0..51e966c 100644 (file)
@@ -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 *|