Skip to main content

ocaml_library

A ocaml_library() rule builds a native and a bytecode libraries from the supplied set of OCaml source files and dependencies.

Details​

Note: Buck is currently tested with 4.X OCaml series.

Function Signature​

def ocaml_library(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _apple_platforms: dict[str, str] = {},
    _cxx_toolchain: str = "gh_facebook_buck2_shims_meta//:cxx",
    _ocaml_toolchain: str = "gh_facebook_buck2_shims_meta//:ocaml",
    bytecode_only: bool = False,
    compiler_flags: list[str] = [],
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    deps: list[str] = [],
    labels: list[str] = [],
    licenses: list[str] = [],
    linker_flags: list[str] = [],
    native_plugin: bool = False,
    ocamldep_flags: list[str] = [],
    platform_compiler_flags: list[(str, list[str])] = [],
    platform_deps: list[(str, list[str])] = [],
    srcs: None | list[str] | dict[str, str] = None,
    warnings_flags: None | str = None,
) -> None

Parameters​

  • name: (required)

    name of the target

  • default_target_platform: (defaults to: None)

    specifies the default target platform, used when no platforms are specified on the command line

  • target_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with a configuration

  • exec_compatible_with: (defaults to: [])

    a list of constraints that are required to be satisfied for this target to be compatible with an execution platform

  • visibility: (defaults to: [])

    a list of visibility patterns restricting what targets can depend on this one

  • within_view: (defaults to: ["PUBLIC"])

    a list of visibility patterns restricting what this target can depend on

  • metadata: (defaults to: {})

    a key-value map of metadata associated with this target

  • tests: (defaults to: [])

    a list of targets that provide tests for this one

  • modifiers: (defaults to: [])

    an array of modifiers associated with this target

  • compiler_flags: (defaults to: [])

    The set of additional compiler flags to pass to ocaml compiler. It supports specifying ppx (see for example).

  • deps: (defaults to: [])

    The set of dependencies of this rule. It could include references to ocaml_library and cxx_library rules.

  • platform_deps: (defaults to: [])

    Platform specific dependencies. These should be specified as a list of pairs where the first element is an un-anchored regex (in java.util.regex.Pattern syntax) against which the platform name is matched, and the second element is a list of dependencies (same format as deps) that are exported if the platform matches the regex. See deps for more information.

  • srcs: (defaults to: None)

    The set of source files to be compiled by this rule. It supports *.ml, *.mli, *.mly, *.mll, and *.c files. (see this test as C interop example and this test as parser and lexer example).

Examples​

For more examples, check out our integration tests.



ocaml_library(
  name='greeting',
  srcs=[
    'greeting.ml',
  ],
  deps=[
    ':join',
  ],
)