This is an archive of the discontinued LLVM Phabricator instance.

Differential D77884

fix the documentation for ocaml bindings
ClosedPublic

Authored by HuStmpHrrr on Apr 10 2020, 10:01 AM.

Details

Reviewers
jhenderson
aqjune
gribozavr
whitequark
chandlerc
Commits
rGcca3167de0b6: [NFC][OCaml] Fix documentation for verify_function and const_of_int64
Summary

Certain texts are wrong.

Diff Detail

Event Timeline

HuStmpHrrr created this revision.Apr 10 2020, 10:01 AM
Herald added a project: Restricted Project. · View Herald TranscriptApr 10 2020, 10:01 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
whitequark accepted this revision.Apr 10 2020, 10:20 AM

LGTM

This revision is now accepted and ready to land.Apr 10 2020, 10:20 AM
Harbormaster completed remote builds in B52688: Diff 256595.Apr 10 2020, 10:30 AM
Closed by commit rGcca3167de0b6: [NFC][OCaml] Fix documentation for verify_function and const_of_int64 (authored by HuStmpHrrr, committed by jberdine). · Explain WhyMar 17 2021, 5:10 AM
This revision was automatically updated to reflect the committed changes.
jberdine added a commit: rGcca3167de0b6: [NFC][OCaml] Fix documentation for verify_function and const_of_int64.

Revision Contents

PathSize
llvm/
bindings/
ocaml/
analysis/
5 lines
llvm/
5 lines

Diff 256595

llvm/bindings/ocaml/analysis/llvm_analysis.mli

Show All 10 Lines(** 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. *) the Analysis library. *)
(** [verify_module m] returns [None] if the module [m] is valid, and (** [verify_module m] returns [None] if the module [m] is valid, and
[Some reason] if it is invalid. [reason] is a string containing a [Some reason] if it is invalid. [reason] is a string containing a
human-readable validation report. See [llvm::verifyModule]. *) human-readable validation report. See [llvm::verifyModule]. *)
external verify_module : Llvm.llmodule -> string option = "llvm_verify_module" external verify_module : Llvm.llmodule -> string option = "llvm_verify_module"
(** [verify_function f] returns [None] if the function [f] is valid, and (** [verify_function f] returns [true] if the function [f] is valid, and
[Some reason] if it is invalid. [reason] is a string containing a [false] if it is invalid. See [llvm::verifyFunction]. *)
human-readable validation report. See [llvm::verifyFunction]. *)
external verify_function : Llvm.llvalue -> bool = "llvm_verify_function" external verify_function : Llvm.llvalue -> bool = "llvm_verify_function"
(** [verify_module m] returns if the module [m] is valid, but prints a (** [verify_module m] returns if the module [m] is valid, but prints a
validation report to [stderr] and aborts the program if it is invalid. See validation report to [stderr] and aborts the program if it is invalid. See
[llvm::verifyModule]. *) [llvm::verifyModule]. *)
external assert_valid_module : Llvm.llmodule -> unit external assert_valid_module : Llvm.llmodule -> unit
= "llvm_assert_valid_module" = "llvm_assert_valid_module"
Show All 16 Lines

llvm/bindings/ocaml/llvm/llvm.mli

Show First 20 Lines • Show All 911 Lines • ▼ Show 20 Lines
(** {7 Operations on scalar constants} *) (** {7 Operations on scalar constants} *)
(** [const_int ty i] returns the integer constant of type [ty] and value [i]. (** [const_int ty i] returns the integer constant of type [ty] and value [i].
See the method [llvm::ConstantInt::get]. *) See the method [llvm::ConstantInt::get]. *)
val const_int : lltype -> int -> llvalue val const_int : lltype -> int -> llvalue
(** [const_of_int64 ty i] returns the integer constant of type [ty] and value (** [const_of_int64 ty i s] returns the integer constant of type [ty] and value
[i]. See the method [llvm::ConstantInt::get]. *) [i]. [s] indicates whether the integer is signed or not.
See the method [llvm::ConstantInt::get]. *)
val const_of_int64 : lltype -> Int64.t -> bool -> llvalue val const_of_int64 : lltype -> Int64.t -> bool -> llvalue
(** [int64_of_const c] returns the int64 value of the [c] constant integer. (** [int64_of_const c] returns the int64 value of the [c] constant integer.
None is returned if this is not an integer constant, or bitwidth exceeds 64. None is returned if this is not an integer constant, or bitwidth exceeds 64.
See the method [llvm::ConstantInt::getSExtValue].*) See the method [llvm::ConstantInt::getSExtValue].*)
val int64_of_const : llvalue -> Int64.t option val int64_of_const : llvalue -> Int64.t option
(** [const_int_of_string ty s r] returns the integer constant of type [ty] and (** [const_int_of_string ty s r] returns the integer constant of type [ty] and
▲ Show 20 Lines • Show All 1,744 Lines • Show Last 20 Lines