From 996bbac5f3e6d8dc21d0e3188a0021e70ebe61e8 Mon Sep 17 00:00:00 2001 From: c-cube Date: Fri, 2 May 2025 13:22:20 +0000 Subject: [PATCH] deploy: 384dca93e28754a0664f9d9e1b838074a17205b9 --- ocaml/Build_path_prefix_map/index.html | 2 +- ocaml/Bytesections/index.html | 6 +++++- ocaml/Compression/index.html | 2 +- ocaml/Config/index.html | 2 +- ocaml/Config_boot/index.html | 2 +- ocaml/Config_main/index.html | 2 +- ocaml/Local_store/index.html | 2 +- ocaml/Odoc_comments_global/index.html | 2 +- ocaml/Odoc_config/index.html | 2 +- ocaml/Odoc_messages/index.html | 2 +- ocaml/Profiling/index.html | 2 +- ocaml/Terminfo/index.html | 2 +- ocaml/X86_gas/index.html | 2 +- ocaml/X86_masm/index.html | 2 +- trace/Trace/index.html | 2 +- trace/Trace_core/index.html | 2 +- 16 files changed, 20 insertions(+), 16 deletions(-) diff --git a/ocaml/Build_path_prefix_map/index.html b/ocaml/Build_path_prefix_map/index.html index 9e5ebc2..01731af 100644 --- a/ocaml/Build_path_prefix_map/index.html +++ b/ocaml/Build_path_prefix_map/index.html @@ -1,2 +1,2 @@ -Build_path_prefix_map (ocaml.Build_path_prefix_map)

Module Build_path_prefix_map

Rewrite paths for reproducible builds

Warning: this module is unstable and part of compiler-libs.

See the BUILD_PATH_PREFIX_MAP spec

type path = string
type path_prefix = string
type error_message = string
val encode_prefix : path_prefix -> string
val decode_prefix : string -> (path_prefix, error_message) result
type pair = {
  1. target : path_prefix;
  2. source : path_prefix;
}
val encode_pair : pair -> string
val decode_pair : string -> (pair, error_message) result
type map = pair option list
val encode_map : map -> string
val decode_map : string -> (map, error_message) result
val rewrite_first : map -> path -> path option

rewrite_first map path tries to find a source in map that is a prefix of the input path. If it succeeds, it replaces this prefix with the corresponding target. If it fails, it just returns None.

val rewrite_all : map -> path -> path list

rewrite_all map path finds all sources in map that are a prefix of the input path. For each matching source, in priority order, it replaces this prefix with the corresponding target and adds the result to the returned list. If there are no matches, it just returns [].

val rewrite : map -> path -> path

rewrite path uses rewrite_first to try to find a mapping for path. If found, it returns that, otherwise it just returns path.

\ No newline at end of file +Build_path_prefix_map (ocaml.Build_path_prefix_map)

Module Build_path_prefix_map

Rewrite paths for reproducible builds

Warning: this module is unstable and part of compiler-libs.

See the BUILD_PATH_PREFIX_MAP spec

type path = string
type path_prefix = string
type error_message = string
val encode_prefix : path_prefix -> string
val decode_prefix : string -> (path_prefix, error_message) Stdlib.result
type pair = {
  1. target : path_prefix;
  2. source : path_prefix;
}
val encode_pair : pair -> string
val decode_pair : string -> (pair, error_message) Stdlib.result
type map = pair option list
val encode_map : map -> string
val decode_map : string -> (map, error_message) Stdlib.result
val rewrite_first : map -> path -> path option

rewrite_first map path tries to find a source in map that is a prefix of the input path. If it succeeds, it replaces this prefix with the corresponding target. If it fails, it just returns None.

val rewrite_all : map -> path -> path list

rewrite_all map path finds all sources in map that are a prefix of the input path. For each matching source, in priority order, it replaces this prefix with the corresponding target and adds the result to the returned list. If there are no matches, it just returns [].

val rewrite : map -> path -> path

rewrite path uses rewrite_first to try to find a mapping for path. If found, it returns that, otherwise it just returns path.

\ No newline at end of file diff --git a/ocaml/Bytesections/index.html b/ocaml/Bytesections/index.html index 112a7ba..3c88aa2 100644 --- a/ocaml/Bytesections/index.html +++ b/ocaml/Bytesections/index.html @@ -1,2 +1,6 @@ -Bytesections (ocaml.Bytesections)

Module Bytesections

module Name : sig ... end

Recording sections written to a bytecode executable file

type toc_writer
val init_record : out_channel -> toc_writer

Start recording sections from the current position in out_channel

val record : toc_writer -> Name.t -> unit

Record the current position in the out_channel as the end of the section with the given name.

val write_toc_and_trailer : toc_writer -> unit

Write the table of contents and the standard trailer for bytecode executable files

Reading sections from a bytecode executable file

type section_entry = {
  1. name : Name.t;
    (*

    name of the section.

    *)
  2. pos : int;
    (*

    byte offset at which the section starts.

    *)
  3. len : int;
    (*

    length of the section.

    *)
}
type section_table
exception Bad_magic_number
val read_toc : in_channel -> section_table

Read the table of sections from a bytecode executable. Raise Bad_magic_number if magic number doesn't match

val seek_section : section_table -> in_channel -> Name.t -> int

Position the input channel at the beginning of the section named "name", and return the length of that section. Raise Not_found if no such section exists.

val read_section_string : section_table -> in_channel -> Name.t -> string

Return the contents of a section, as a string.

val read_section_struct : section_table -> in_channel -> Name.t -> 'a

Return the contents of a section, as marshalled data.

val all : section_table -> section_entry list

Returns all section_entry from a section_table in increasing position order.

val pos_first_section : section_table -> int

Return the position of the beginning of the first section

\ No newline at end of file +Bytesections (ocaml.Bytesections)

Module Bytesections

module Name : sig ... end

Recording sections written to a bytecode executable file

type toc_writer
val init_record : Stdlib.out_channel -> toc_writer

Start recording sections from the current position in out_channel

val record : toc_writer -> Name.t -> unit

Record the current position in the out_channel as the end of the section with the given name.

val write_toc_and_trailer : toc_writer -> unit

Write the table of contents and the standard trailer for bytecode executable files

Reading sections from a bytecode executable file

type section_entry = {
  1. name : Name.t;
    (*

    name of the section.

    *)
  2. pos : int;
    (*

    byte offset at which the section starts.

    *)
  3. len : int;
    (*

    length of the section.

    *)
}
type section_table
exception Bad_magic_number

Read the table of sections from a bytecode executable. Raise Bad_magic_number if magic number doesn't match

val seek_section : section_table -> Stdlib.in_channel -> Name.t -> int

Position the input channel at the beginning of the section named "name", and return the length of that section. Raise Not_found if no such section exists.

val read_section_string : + section_table -> + Stdlib.in_channel -> + Name.t -> + string

Return the contents of a section, as a string.

val read_section_struct : section_table -> Stdlib.in_channel -> Name.t -> 'a

Return the contents of a section, as marshalled data.

val all : section_table -> section_entry list

Returns all section_entry from a section_table in increasing position order.

val pos_first_section : section_table -> int

Return the position of the beginning of the first section

\ No newline at end of file diff --git a/ocaml/Compression/index.html b/ocaml/Compression/index.html index eeea9a6..8e49a27 100644 --- a/ocaml/Compression/index.html +++ b/ocaml/Compression/index.html @@ -1,2 +1,2 @@ -Compression (ocaml.Compression)

Module Compression

val output_value : out_channel -> 'a -> unit

Compression.output_value chan v writes the representation of v on channel chan. If compression is supported, the marshaled data representing value v is compressed before being written to channel chan. If compression is not supported, this function behaves like Stdlib.output_value.

val input_value : in_channel -> 'a

Compression.input_value chan reads from channel chan the byte representation of a structured value, as produced by Compression.output_value, and reconstructs and returns the corresponding value. If compression is not supported, this function behaves like Stdlib.input_value.

val compression_supported : bool

Reports whether compression is supported.

\ No newline at end of file +Compression (ocaml.Compression)

Module Compression

val output_value : Stdlib.out_channel -> 'a -> unit

Compression.output_value chan v writes the representation of v on channel chan. If compression is supported, the marshaled data representing value v is compressed before being written to channel chan. If compression is not supported, this function behaves like Stdlib.output_value.

val input_value : Stdlib.in_channel -> 'a

Compression.input_value chan reads from channel chan the byte representation of a structured value, as produced by Compression.output_value, and reconstructs and returns the corresponding value. If compression is not supported, this function behaves like Stdlib.input_value.

val compression_supported : bool

Reports whether compression is supported.

\ No newline at end of file diff --git a/ocaml/Config/index.html b/ocaml/Config/index.html index 21bca09..d67b9d0 100644 --- a/ocaml/Config/index.html +++ b/ocaml/Config/index.html @@ -1,2 +1,2 @@ -Config (ocaml.Config)

Module Config

System configuration

Warning: this module is unstable and part of compiler-libs.

val version : string

The current version number of the system

val bindir : string

The directory containing the binary programs

val standard_library : string

The directory containing the standard libraries

val ccomp_type : string

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

val c_compiler : string

The compiler to use for compiling C files

val c_output_obj : string

Name of the option of the C compiler for specifying the output file

val c_has_debug_prefix_map : bool

Whether the C compiler supports -fdebug-prefix-map

val as_has_debug_prefix_map : bool

Whether the assembler supports --debug-prefix-map

val ocamlc_cflags : string

The flags ocamlc should pass to the C compiler

val ocamlc_cppflags : string

The flags ocamlc should pass to the C preprocessor

val ocamlopt_cflags : string
  • deprecated

    ocamlc_cflags should be used instead. The flags ocamlopt should pass to the C compiler

val ocamlopt_cppflags : string
  • deprecated

    ocamlc_cppflags should be used instead. The flags ocamlopt should pass to the C preprocessor

val bytecomp_c_libraries : string

The C libraries to link with custom runtimes

val native_c_libraries : string

The C libraries to link with native-code programs

val native_pack_linker : string

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

val mkdll : string

The linker command line to build dynamic libraries.

val mkexe : string

The linker command line to build executables.

val mkmaindll : string

The linker command line to build main programs as dlls.

val default_rpath : string

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

val mksharedlibrpath : string

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

val ar : string

Name of the ar command, or "" if not needed (MSVC)

val interface_suffix : string ref

Suffix for interface file names

val exec_magic_number : string

Magic number for bytecode executable files

val cmi_magic_number : string

Magic number for compiled interface files

val cmo_magic_number : string

Magic number for object bytecode files

val cma_magic_number : string

Magic number for archive files

val cmx_magic_number : string

Magic number for compilation unit descriptions

val cmxa_magic_number : string

Magic number for libraries of compilation unit descriptions

val ast_intf_magic_number : string

Magic number for file holding an interface syntax tree

val ast_impl_magic_number : string

Magic number for file holding an implementation syntax tree

val cmxs_magic_number : string

Magic number for dynamically-loadable plugins

val cmt_magic_number : string

Magic number for compiled interface files

val linear_magic_number : string

Magic number for Linear internal representation files

val max_tag : int

Biggest tag that can be stored in the header of a regular block.

val lazy_tag : int

Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.

val max_young_wosize : int

Maximal size of arrays that are directly allocated in the minor heap

val stack_threshold : int

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

val stack_safety_margin : int

Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.

val native_compiler : bool

Whether the native compiler is available or not

  • since 5.1
val architecture : string

Name of processor type for the native-code compiler

val model : string

Name of processor submodel for the native-code compiler

val system : string

Name of operating system for the native-code compiler

val asm : string

The assembler (and flags) to use for assembling ocamlopt-generated code.

val asm_cfi_supported : bool

Whether assembler understands CFI directives

val with_frame_pointers : bool

Whether assembler should maintain frame pointers

val ext_obj : string

Extension for object files, e.g. .o under Unix.

val ext_asm : string

Extension for assembler files, e.g. .s under Unix.

val ext_lib : string

Extension for library files, e.g. .a under Unix.

val ext_dll : string

Extension for dynamically-loaded libraries, e.g. .so under Unix.

val ext_exe : string

Extension for executable programs, e.g. .exe under Windows.

  • since 4.12
val default_executable_name : string

Name of executable produced by linking if none is given with -o, e.g. a.out under Unix.

val systhread_supported : bool

Whether the system thread library is implemented

val flexdll_dirs : string list

Directories needed for the FlexDLL objects

val host : string

Whether the compiler is a cross-compiler

val target : string

Whether the compiler is a cross-compiler

val flambda : bool

Whether the compiler was configured for flambda

val with_flambda_invariants : bool

Whether the invariants checks for flambda are enabled

val with_cmm_invariants : bool

Whether the invariants checks for Cmm are enabled

val reserved_header_bits : int

How many bits of a block's header are reserved

val flat_float_array : bool

Whether the compiler and runtime automagically flatten float arrays

val function_sections : bool

Whether the compiler was configured to generate each function in a separate section

val windows_unicode : bool

Whether Windows Unicode runtime is enabled

val naked_pointers : bool

Whether the runtime supports naked pointers

  • since 4.14
val supports_shared_libraries : bool

Whether shared libraries are supported

  • since 4.08

Whether native shared libraries are supported

  • since 5.1
val afl_instrument : bool

Whether afl-fuzz instrumentation is generated by default

val ar_supports_response_files : bool

Whether ar supports @FILE arguments.

val print_config : out_channel -> unit

Access to configuration values

val config_var : string -> string option

the configuration value of a variable, if it exists

\ No newline at end of file +Config (ocaml.Config)

Module Config

System configuration

Warning: this module is unstable and part of compiler-libs.

val version : string

The current version number of the system

val bindir : string

The directory containing the binary programs

val standard_library : string

The directory containing the standard libraries

val ccomp_type : string

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

val c_compiler : string

The compiler to use for compiling C files

val c_output_obj : string

Name of the option of the C compiler for specifying the output file

val c_has_debug_prefix_map : bool

Whether the C compiler supports -fdebug-prefix-map

val as_has_debug_prefix_map : bool

Whether the assembler supports --debug-prefix-map

val ocamlc_cflags : string

The flags ocamlc should pass to the C compiler

val ocamlc_cppflags : string

The flags ocamlc should pass to the C preprocessor

val ocamlopt_cflags : string
  • deprecated

    ocamlc_cflags should be used instead. The flags ocamlopt should pass to the C compiler

val ocamlopt_cppflags : string
  • deprecated

    ocamlc_cppflags should be used instead. The flags ocamlopt should pass to the C preprocessor

val bytecomp_c_libraries : string

The C libraries to link with custom runtimes

val native_c_libraries : string

The C libraries to link with native-code programs

val native_pack_linker : string

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

val mkdll : string

The linker command line to build dynamic libraries.

val mkexe : string

The linker command line to build executables.

val mkmaindll : string

The linker command line to build main programs as dlls.

val default_rpath : string

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

val mksharedlibrpath : string

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

val ar : string

Name of the ar command, or "" if not needed (MSVC)

val interface_suffix : string Stdlib.ref

Suffix for interface file names

val exec_magic_number : string

Magic number for bytecode executable files

val cmi_magic_number : string

Magic number for compiled interface files

val cmo_magic_number : string

Magic number for object bytecode files

val cma_magic_number : string

Magic number for archive files

val cmx_magic_number : string

Magic number for compilation unit descriptions

val cmxa_magic_number : string

Magic number for libraries of compilation unit descriptions

val ast_intf_magic_number : string

Magic number for file holding an interface syntax tree

val ast_impl_magic_number : string

Magic number for file holding an implementation syntax tree

val cmxs_magic_number : string

Magic number for dynamically-loadable plugins

val cmt_magic_number : string

Magic number for compiled interface files

val linear_magic_number : string

Magic number for Linear internal representation files

val max_tag : int

Biggest tag that can be stored in the header of a regular block.

val lazy_tag : int

Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.

val max_young_wosize : int

Maximal size of arrays that are directly allocated in the minor heap

val stack_threshold : int

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

val stack_safety_margin : int

Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.

val native_compiler : bool

Whether the native compiler is available or not

  • since 5.1
val architecture : string

Name of processor type for the native-code compiler

val model : string

Name of processor submodel for the native-code compiler

val system : string

Name of operating system for the native-code compiler

val asm : string

The assembler (and flags) to use for assembling ocamlopt-generated code.

val asm_cfi_supported : bool

Whether assembler understands CFI directives

val with_frame_pointers : bool

Whether assembler should maintain frame pointers

val ext_obj : string

Extension for object files, e.g. .o under Unix.

val ext_asm : string

Extension for assembler files, e.g. .s under Unix.

val ext_lib : string

Extension for library files, e.g. .a under Unix.

val ext_dll : string

Extension for dynamically-loaded libraries, e.g. .so under Unix.

val ext_exe : string

Extension for executable programs, e.g. .exe under Windows.

  • since 4.12
val default_executable_name : string

Name of executable produced by linking if none is given with -o, e.g. a.out under Unix.

val systhread_supported : bool

Whether the system thread library is implemented

val flexdll_dirs : string list

Directories needed for the FlexDLL objects

val host : string

Whether the compiler is a cross-compiler

val target : string

Whether the compiler is a cross-compiler

val flambda : bool

Whether the compiler was configured for flambda

val with_flambda_invariants : bool

Whether the invariants checks for flambda are enabled

val with_cmm_invariants : bool

Whether the invariants checks for Cmm are enabled

val reserved_header_bits : int

How many bits of a block's header are reserved

val flat_float_array : bool

Whether the compiler and runtime automagically flatten float arrays

val function_sections : bool

Whether the compiler was configured to generate each function in a separate section

val windows_unicode : bool

Whether Windows Unicode runtime is enabled

val naked_pointers : bool

Whether the runtime supports naked pointers

  • since 4.14
val supports_shared_libraries : bool

Whether shared libraries are supported

  • since 4.08

Whether native shared libraries are supported

  • since 5.1
val afl_instrument : bool

Whether afl-fuzz instrumentation is generated by default

val ar_supports_response_files : bool

Whether ar supports @FILE arguments.

val print_config : Stdlib.out_channel -> unit

Access to configuration values

val config_var : string -> string option

the configuration value of a variable, if it exists

\ No newline at end of file diff --git a/ocaml/Config_boot/index.html b/ocaml/Config_boot/index.html index 507cdb6..e21f22b 100644 --- a/ocaml/Config_boot/index.html +++ b/ocaml/Config_boot/index.html @@ -1,2 +1,2 @@ -Config_boot (ocaml.Config_boot)

Module Config_boot

System configuration

Warning: this module is unstable and part of compiler-libs.

val version : string

The current version number of the system

val bindir : string

The directory containing the binary programs

val standard_library : string

The directory containing the standard libraries

val ccomp_type : string

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

val c_compiler : string

The compiler to use for compiling C files

val c_output_obj : string

Name of the option of the C compiler for specifying the output file

val c_has_debug_prefix_map : bool

Whether the C compiler supports -fdebug-prefix-map

val as_has_debug_prefix_map : bool

Whether the assembler supports --debug-prefix-map

val ocamlc_cflags : string

The flags ocamlc should pass to the C compiler

val ocamlc_cppflags : string

The flags ocamlc should pass to the C preprocessor

val ocamlopt_cflags : string
  • deprecated

    ocamlc_cflags should be used instead. The flags ocamlopt should pass to the C compiler

val ocamlopt_cppflags : string
  • deprecated

    ocamlc_cppflags should be used instead. The flags ocamlopt should pass to the C preprocessor

val bytecomp_c_libraries : string

The C libraries to link with custom runtimes

val native_c_libraries : string

The C libraries to link with native-code programs

val native_pack_linker : string

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

val mkdll : string

The linker command line to build dynamic libraries.

val mkexe : string

The linker command line to build executables.

val mkmaindll : string

The linker command line to build main programs as dlls.

val default_rpath : string

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

val mksharedlibrpath : string

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

val ar : string

Name of the ar command, or "" if not needed (MSVC)

val interface_suffix : string ref

Suffix for interface file names

val exec_magic_number : string

Magic number for bytecode executable files

val cmi_magic_number : string

Magic number for compiled interface files

val cmo_magic_number : string

Magic number for object bytecode files

val cma_magic_number : string

Magic number for archive files

val cmx_magic_number : string

Magic number for compilation unit descriptions

val cmxa_magic_number : string

Magic number for libraries of compilation unit descriptions

val ast_intf_magic_number : string

Magic number for file holding an interface syntax tree

val ast_impl_magic_number : string

Magic number for file holding an implementation syntax tree

val cmxs_magic_number : string

Magic number for dynamically-loadable plugins

val cmt_magic_number : string

Magic number for compiled interface files

val linear_magic_number : string

Magic number for Linear internal representation files

val max_tag : int

Biggest tag that can be stored in the header of a regular block.

val lazy_tag : int

Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.

val max_young_wosize : int

Maximal size of arrays that are directly allocated in the minor heap

val stack_threshold : int

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

val stack_safety_margin : int

Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.

val native_compiler : bool

Whether the native compiler is available or not

  • since 5.1
val architecture : string

Name of processor type for the native-code compiler

val model : string

Name of processor submodel for the native-code compiler

val system : string

Name of operating system for the native-code compiler

val asm : string

The assembler (and flags) to use for assembling ocamlopt-generated code.

val asm_cfi_supported : bool

Whether assembler understands CFI directives

val with_frame_pointers : bool

Whether assembler should maintain frame pointers

val ext_obj : string

Extension for object files, e.g. .o under Unix.

val ext_asm : string

Extension for assembler files, e.g. .s under Unix.

val ext_lib : string

Extension for library files, e.g. .a under Unix.

val ext_dll : string

Extension for dynamically-loaded libraries, e.g. .so under Unix.

val ext_exe : string

Extension for executable programs, e.g. .exe under Windows.

  • since 4.12
val default_executable_name : string

Name of executable produced by linking if none is given with -o, e.g. a.out under Unix.

val systhread_supported : bool

Whether the system thread library is implemented

val flexdll_dirs : string list

Directories needed for the FlexDLL objects

val host : string

Whether the compiler is a cross-compiler

val target : string

Whether the compiler is a cross-compiler

val flambda : bool

Whether the compiler was configured for flambda

val with_flambda_invariants : bool

Whether the invariants checks for flambda are enabled

val with_cmm_invariants : bool

Whether the invariants checks for Cmm are enabled

val reserved_header_bits : int

How many bits of a block's header are reserved

val flat_float_array : bool

Whether the compiler and runtime automagically flatten float arrays

val function_sections : bool

Whether the compiler was configured to generate each function in a separate section

val windows_unicode : bool

Whether Windows Unicode runtime is enabled

val naked_pointers : bool

Whether the runtime supports naked pointers

  • since 4.14
val supports_shared_libraries : bool

Whether shared libraries are supported

  • since 4.08

Whether native shared libraries are supported

  • since 5.1
val afl_instrument : bool

Whether afl-fuzz instrumentation is generated by default

val ar_supports_response_files : bool

Whether ar supports @FILE arguments.

val print_config : out_channel -> unit

Access to configuration values

val config_var : string -> string option

the configuration value of a variable, if it exists

\ No newline at end of file +Config_boot (ocaml.Config_boot)

Module Config_boot

System configuration

Warning: this module is unstable and part of compiler-libs.

val version : string

The current version number of the system

val bindir : string

The directory containing the binary programs

val standard_library : string

The directory containing the standard libraries

val ccomp_type : string

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

val c_compiler : string

The compiler to use for compiling C files

val c_output_obj : string

Name of the option of the C compiler for specifying the output file

val c_has_debug_prefix_map : bool

Whether the C compiler supports -fdebug-prefix-map

val as_has_debug_prefix_map : bool

Whether the assembler supports --debug-prefix-map

val ocamlc_cflags : string

The flags ocamlc should pass to the C compiler

val ocamlc_cppflags : string

The flags ocamlc should pass to the C preprocessor

val ocamlopt_cflags : string
  • deprecated

    ocamlc_cflags should be used instead. The flags ocamlopt should pass to the C compiler

val ocamlopt_cppflags : string
  • deprecated

    ocamlc_cppflags should be used instead. The flags ocamlopt should pass to the C preprocessor

val bytecomp_c_libraries : string

The C libraries to link with custom runtimes

val native_c_libraries : string

The C libraries to link with native-code programs

val native_pack_linker : string

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

val mkdll : string

The linker command line to build dynamic libraries.

val mkexe : string

The linker command line to build executables.

val mkmaindll : string

The linker command line to build main programs as dlls.

val default_rpath : string

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

val mksharedlibrpath : string

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

val ar : string

Name of the ar command, or "" if not needed (MSVC)

val interface_suffix : string Stdlib.ref

Suffix for interface file names

val exec_magic_number : string

Magic number for bytecode executable files

val cmi_magic_number : string

Magic number for compiled interface files

val cmo_magic_number : string

Magic number for object bytecode files

val cma_magic_number : string

Magic number for archive files

val cmx_magic_number : string

Magic number for compilation unit descriptions

val cmxa_magic_number : string

Magic number for libraries of compilation unit descriptions

val ast_intf_magic_number : string

Magic number for file holding an interface syntax tree

val ast_impl_magic_number : string

Magic number for file holding an implementation syntax tree

val cmxs_magic_number : string

Magic number for dynamically-loadable plugins

val cmt_magic_number : string

Magic number for compiled interface files

val linear_magic_number : string

Magic number for Linear internal representation files

val max_tag : int

Biggest tag that can be stored in the header of a regular block.

val lazy_tag : int

Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.

val max_young_wosize : int

Maximal size of arrays that are directly allocated in the minor heap

val stack_threshold : int

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

val stack_safety_margin : int

Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.

val native_compiler : bool

Whether the native compiler is available or not

  • since 5.1
val architecture : string

Name of processor type for the native-code compiler

val model : string

Name of processor submodel for the native-code compiler

val system : string

Name of operating system for the native-code compiler

val asm : string

The assembler (and flags) to use for assembling ocamlopt-generated code.

val asm_cfi_supported : bool

Whether assembler understands CFI directives

val with_frame_pointers : bool

Whether assembler should maintain frame pointers

val ext_obj : string

Extension for object files, e.g. .o under Unix.

val ext_asm : string

Extension for assembler files, e.g. .s under Unix.

val ext_lib : string

Extension for library files, e.g. .a under Unix.

val ext_dll : string

Extension for dynamically-loaded libraries, e.g. .so under Unix.

val ext_exe : string

Extension for executable programs, e.g. .exe under Windows.

  • since 4.12
val default_executable_name : string

Name of executable produced by linking if none is given with -o, e.g. a.out under Unix.

val systhread_supported : bool

Whether the system thread library is implemented

val flexdll_dirs : string list

Directories needed for the FlexDLL objects

val host : string

Whether the compiler is a cross-compiler

val target : string

Whether the compiler is a cross-compiler

val flambda : bool

Whether the compiler was configured for flambda

val with_flambda_invariants : bool

Whether the invariants checks for flambda are enabled

val with_cmm_invariants : bool

Whether the invariants checks for Cmm are enabled

val reserved_header_bits : int

How many bits of a block's header are reserved

val flat_float_array : bool

Whether the compiler and runtime automagically flatten float arrays

val function_sections : bool

Whether the compiler was configured to generate each function in a separate section

val windows_unicode : bool

Whether Windows Unicode runtime is enabled

val naked_pointers : bool

Whether the runtime supports naked pointers

  • since 4.14
val supports_shared_libraries : bool

Whether shared libraries are supported

  • since 4.08

Whether native shared libraries are supported

  • since 5.1
val afl_instrument : bool

Whether afl-fuzz instrumentation is generated by default

val ar_supports_response_files : bool

Whether ar supports @FILE arguments.

val print_config : Stdlib.out_channel -> unit

Access to configuration values

val config_var : string -> string option

the configuration value of a variable, if it exists

\ No newline at end of file diff --git a/ocaml/Config_main/index.html b/ocaml/Config_main/index.html index ab1b90a..2c3da1f 100644 --- a/ocaml/Config_main/index.html +++ b/ocaml/Config_main/index.html @@ -1,2 +1,2 @@ -Config_main (ocaml.Config_main)

Module Config_main

System configuration

Warning: this module is unstable and part of compiler-libs.

val version : string

The current version number of the system

val bindir : string

The directory containing the binary programs

val standard_library : string

The directory containing the standard libraries

val ccomp_type : string

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

val c_compiler : string

The compiler to use for compiling C files

val c_output_obj : string

Name of the option of the C compiler for specifying the output file

val c_has_debug_prefix_map : bool

Whether the C compiler supports -fdebug-prefix-map

val as_has_debug_prefix_map : bool

Whether the assembler supports --debug-prefix-map

val ocamlc_cflags : string

The flags ocamlc should pass to the C compiler

val ocamlc_cppflags : string

The flags ocamlc should pass to the C preprocessor

val ocamlopt_cflags : string
  • deprecated

    ocamlc_cflags should be used instead. The flags ocamlopt should pass to the C compiler

val ocamlopt_cppflags : string
  • deprecated

    ocamlc_cppflags should be used instead. The flags ocamlopt should pass to the C preprocessor

val bytecomp_c_libraries : string

The C libraries to link with custom runtimes

val native_c_libraries : string

The C libraries to link with native-code programs

val native_pack_linker : string

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

val mkdll : string

The linker command line to build dynamic libraries.

val mkexe : string

The linker command line to build executables.

val mkmaindll : string

The linker command line to build main programs as dlls.

val default_rpath : string

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

val mksharedlibrpath : string

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

val ar : string

Name of the ar command, or "" if not needed (MSVC)

val interface_suffix : string ref

Suffix for interface file names

val exec_magic_number : string

Magic number for bytecode executable files

val cmi_magic_number : string

Magic number for compiled interface files

val cmo_magic_number : string

Magic number for object bytecode files

val cma_magic_number : string

Magic number for archive files

val cmx_magic_number : string

Magic number for compilation unit descriptions

val cmxa_magic_number : string

Magic number for libraries of compilation unit descriptions

val ast_intf_magic_number : string

Magic number for file holding an interface syntax tree

val ast_impl_magic_number : string

Magic number for file holding an implementation syntax tree

val cmxs_magic_number : string

Magic number for dynamically-loadable plugins

val cmt_magic_number : string

Magic number for compiled interface files

val linear_magic_number : string

Magic number for Linear internal representation files

val max_tag : int

Biggest tag that can be stored in the header of a regular block.

val lazy_tag : int

Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.

val max_young_wosize : int

Maximal size of arrays that are directly allocated in the minor heap

val stack_threshold : int

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

val stack_safety_margin : int

Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.

val native_compiler : bool

Whether the native compiler is available or not

  • since 5.1
val architecture : string

Name of processor type for the native-code compiler

val model : string

Name of processor submodel for the native-code compiler

val system : string

Name of operating system for the native-code compiler

val asm : string

The assembler (and flags) to use for assembling ocamlopt-generated code.

val asm_cfi_supported : bool

Whether assembler understands CFI directives

val with_frame_pointers : bool

Whether assembler should maintain frame pointers

val ext_obj : string

Extension for object files, e.g. .o under Unix.

val ext_asm : string

Extension for assembler files, e.g. .s under Unix.

val ext_lib : string

Extension for library files, e.g. .a under Unix.

val ext_dll : string

Extension for dynamically-loaded libraries, e.g. .so under Unix.

val ext_exe : string

Extension for executable programs, e.g. .exe under Windows.

  • since 4.12
val default_executable_name : string

Name of executable produced by linking if none is given with -o, e.g. a.out under Unix.

val systhread_supported : bool

Whether the system thread library is implemented

val flexdll_dirs : string list

Directories needed for the FlexDLL objects

val host : string

Whether the compiler is a cross-compiler

val target : string

Whether the compiler is a cross-compiler

val flambda : bool

Whether the compiler was configured for flambda

val with_flambda_invariants : bool

Whether the invariants checks for flambda are enabled

val with_cmm_invariants : bool

Whether the invariants checks for Cmm are enabled

val reserved_header_bits : int

How many bits of a block's header are reserved

val flat_float_array : bool

Whether the compiler and runtime automagically flatten float arrays

val function_sections : bool

Whether the compiler was configured to generate each function in a separate section

val windows_unicode : bool

Whether Windows Unicode runtime is enabled

val naked_pointers : bool

Whether the runtime supports naked pointers

  • since 4.14
val supports_shared_libraries : bool

Whether shared libraries are supported

  • since 4.08

Whether native shared libraries are supported

  • since 5.1
val afl_instrument : bool

Whether afl-fuzz instrumentation is generated by default

val ar_supports_response_files : bool

Whether ar supports @FILE arguments.

val print_config : out_channel -> unit

Access to configuration values

val config_var : string -> string option

the configuration value of a variable, if it exists

\ No newline at end of file +Config_main (ocaml.Config_main)

Module Config_main

System configuration

Warning: this module is unstable and part of compiler-libs.

val version : string

The current version number of the system

val bindir : string

The directory containing the binary programs

val standard_library : string

The directory containing the standard libraries

val ccomp_type : string

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

val c_compiler : string

The compiler to use for compiling C files

val c_output_obj : string

Name of the option of the C compiler for specifying the output file

val c_has_debug_prefix_map : bool

Whether the C compiler supports -fdebug-prefix-map

val as_has_debug_prefix_map : bool

Whether the assembler supports --debug-prefix-map

val ocamlc_cflags : string

The flags ocamlc should pass to the C compiler

val ocamlc_cppflags : string

The flags ocamlc should pass to the C preprocessor

val ocamlopt_cflags : string
  • deprecated

    ocamlc_cflags should be used instead. The flags ocamlopt should pass to the C compiler

val ocamlopt_cppflags : string
  • deprecated

    ocamlc_cppflags should be used instead. The flags ocamlopt should pass to the C preprocessor

val bytecomp_c_libraries : string

The C libraries to link with custom runtimes

val native_c_libraries : string

The C libraries to link with native-code programs

val native_pack_linker : string

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

val mkdll : string

The linker command line to build dynamic libraries.

val mkexe : string

The linker command line to build executables.

val mkmaindll : string

The linker command line to build main programs as dlls.

val default_rpath : string

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

val mksharedlibrpath : string

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

val ar : string

Name of the ar command, or "" if not needed (MSVC)

val interface_suffix : string Stdlib.ref

Suffix for interface file names

val exec_magic_number : string

Magic number for bytecode executable files

val cmi_magic_number : string

Magic number for compiled interface files

val cmo_magic_number : string

Magic number for object bytecode files

val cma_magic_number : string

Magic number for archive files

val cmx_magic_number : string

Magic number for compilation unit descriptions

val cmxa_magic_number : string

Magic number for libraries of compilation unit descriptions

val ast_intf_magic_number : string

Magic number for file holding an interface syntax tree

val ast_impl_magic_number : string

Magic number for file holding an implementation syntax tree

val cmxs_magic_number : string

Magic number for dynamically-loadable plugins

val cmt_magic_number : string

Magic number for compiled interface files

val linear_magic_number : string

Magic number for Linear internal representation files

val max_tag : int

Biggest tag that can be stored in the header of a regular block.

val lazy_tag : int

Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.

val max_young_wosize : int

Maximal size of arrays that are directly allocated in the minor heap

val stack_threshold : int

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

val stack_safety_margin : int

Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.

val native_compiler : bool

Whether the native compiler is available or not

  • since 5.1
val architecture : string

Name of processor type for the native-code compiler

val model : string

Name of processor submodel for the native-code compiler

val system : string

Name of operating system for the native-code compiler

val asm : string

The assembler (and flags) to use for assembling ocamlopt-generated code.

val asm_cfi_supported : bool

Whether assembler understands CFI directives

val with_frame_pointers : bool

Whether assembler should maintain frame pointers

val ext_obj : string

Extension for object files, e.g. .o under Unix.

val ext_asm : string

Extension for assembler files, e.g. .s under Unix.

val ext_lib : string

Extension for library files, e.g. .a under Unix.

val ext_dll : string

Extension for dynamically-loaded libraries, e.g. .so under Unix.

val ext_exe : string

Extension for executable programs, e.g. .exe under Windows.

  • since 4.12
val default_executable_name : string

Name of executable produced by linking if none is given with -o, e.g. a.out under Unix.

val systhread_supported : bool

Whether the system thread library is implemented

val flexdll_dirs : string list

Directories needed for the FlexDLL objects

val host : string

Whether the compiler is a cross-compiler

val target : string

Whether the compiler is a cross-compiler

val flambda : bool

Whether the compiler was configured for flambda

val with_flambda_invariants : bool

Whether the invariants checks for flambda are enabled

val with_cmm_invariants : bool

Whether the invariants checks for Cmm are enabled

val reserved_header_bits : int

How many bits of a block's header are reserved

val flat_float_array : bool

Whether the compiler and runtime automagically flatten float arrays

val function_sections : bool

Whether the compiler was configured to generate each function in a separate section

val windows_unicode : bool

Whether Windows Unicode runtime is enabled

val naked_pointers : bool

Whether the runtime supports naked pointers

  • since 4.14
val supports_shared_libraries : bool

Whether shared libraries are supported

  • since 4.08

Whether native shared libraries are supported

  • since 5.1
val afl_instrument : bool

Whether afl-fuzz instrumentation is generated by default

val ar_supports_response_files : bool

Whether ar supports @FILE arguments.

val print_config : Stdlib.out_channel -> unit

Access to configuration values

val config_var : string -> string option

the configuration value of a variable, if it exists

\ No newline at end of file diff --git a/ocaml/Local_store/index.html b/ocaml/Local_store/index.html index 464cd0d..1860ae6 100644 --- a/ocaml/Local_store/index.html +++ b/ocaml/Local_store/index.html @@ -1,2 +1,2 @@ -Local_store (ocaml.Local_store)

Module Local_store

This module provides some facilities for creating references (and hash tables) which can easily be snapshoted and restored to an arbitrary version.

It is used throughout the frontend (read: typechecker), to register all (well, hopefully) the global state. Thus making it easy for tools like Merlin to go back and forth typechecking different files.

Creators

val s_ref : 'a -> 'a ref

Similar to Stdlib.ref, except the allocated reference is registered into the store.

val s_table : ('a -> 'b) -> 'a -> 'b ref

Used to register hash tables. Those also need to be placed into refs to be easily swapped out, but one can't just "snapshot" the initial value to create fresh instances, so instead an initializer is required.

Use it like this:

let my_table = s_table Hashtbl.create 42

State management

Note: all the following functions are currently unused inside the compiler codebase. Merlin is their only user at the moment.

type store
val fresh : unit -> store

Returns a fresh instance of the store.

The first time this function is called, it snapshots the value of all the registered references, later calls to fresh will return instances initialized to those values.

val with_store : store -> (unit -> 'a) -> 'a

with_store s f resets all the registered references to the value they have in s for the run of f. If f updates any of the registered refs, s is updated to remember those changes.

val reset : unit -> unit

Resets all the references to the initial snapshot (i.e. to the same values that new instances start with).

val is_bound : unit -> bool

Returns true when a store is active (i.e. when called from the callback passed to with_store), false otherwise.

\ No newline at end of file +Local_store (ocaml.Local_store)

Module Local_store

This module provides some facilities for creating references (and hash tables) which can easily be snapshoted and restored to an arbitrary version.

It is used throughout the frontend (read: typechecker), to register all (well, hopefully) the global state. Thus making it easy for tools like Merlin to go back and forth typechecking different files.

Creators

val s_ref : 'a -> 'a Stdlib.ref

Similar to Stdlib.ref, except the allocated reference is registered into the store.

val s_table : ('a -> 'b) -> 'a -> 'b Stdlib.ref

Used to register hash tables. Those also need to be placed into refs to be easily swapped out, but one can't just "snapshot" the initial value to create fresh instances, so instead an initializer is required.

Use it like this:

let my_table = s_table Hashtbl.create 42

State management

Note: all the following functions are currently unused inside the compiler codebase. Merlin is their only user at the moment.

type store
val fresh : unit -> store

Returns a fresh instance of the store.

The first time this function is called, it snapshots the value of all the registered references, later calls to fresh will return instances initialized to those values.

val with_store : store -> (unit -> 'a) -> 'a

with_store s f resets all the registered references to the value they have in s for the run of f. If f updates any of the registered refs, s is updated to remember those changes.

val reset : unit -> unit

Resets all the references to the initial snapshot (i.e. to the same values that new instances start with).

val is_bound : unit -> bool

Returns true when a store is active (i.e. when called from the callback passed to with_store), false otherwise.

\ No newline at end of file diff --git a/ocaml/Odoc_comments_global/index.html b/ocaml/Odoc_comments_global/index.html index 44afd1f..e32a569 100644 --- a/ocaml/Odoc_comments_global/index.html +++ b/ocaml/Odoc_comments_global/index.html @@ -1,2 +1,2 @@ -Odoc_comments_global (ocaml.Odoc_comments_global)

Module Odoc_comments_global

val nb_chars : int ref
val authors : string list ref
val version : string option ref
val sees : string list ref
val since : string option ref
val before : (string * string) list ref
val deprecated : string option ref
val params : (string * string) list ref
val raised_exceptions : (string * string) list ref
val return_value : string option ref
val customs : (string * string) list ref
val init : unit -> unit
\ No newline at end of file +Odoc_comments_global (ocaml.Odoc_comments_global)

Module Odoc_comments_global

val nb_chars : int Stdlib.ref
val authors : string list Stdlib.ref
val version : string option Stdlib.ref
val sees : string list Stdlib.ref
val since : string option Stdlib.ref
val before : (string * string) list Stdlib.ref
val deprecated : string option Stdlib.ref
val params : (string * string) list Stdlib.ref
val raised_exceptions : (string * string) list Stdlib.ref
val return_value : string option Stdlib.ref
val customs : (string * string) list Stdlib.ref
val init : unit -> unit
\ No newline at end of file diff --git a/ocaml/Odoc_config/index.html b/ocaml/Odoc_config/index.html index 391fc5b..d20662d 100644 --- a/ocaml/Odoc_config/index.html +++ b/ocaml/Odoc_config/index.html @@ -1,2 +1,2 @@ -Odoc_config (ocaml.Odoc_config)

Module Odoc_config

val custom_generators_path : string
val print_warnings : bool ref
\ No newline at end of file +Odoc_config (ocaml.Odoc_config)

Module Odoc_config

val custom_generators_path : string
val print_warnings : bool Stdlib.ref
\ No newline at end of file diff --git a/ocaml/Odoc_messages/index.html b/ocaml/Odoc_messages/index.html index 588921f..34b86e5 100644 --- a/ocaml/Odoc_messages/index.html +++ b/ocaml/Odoc_messages/index.html @@ -1,2 +1,2 @@ -Odoc_messages (ocaml.Odoc_messages)

Module Odoc_messages

The messages of the application.

val ok : string
val software : string
val config_version : string
val magic : string
val usage : string
val options_are : string
val latex_only : string
val texi_only : string
val latex_texi_only : string
val html_only : string
val html_latex_only : string
val html_latex_texi_only : string
val man_only : string
val option_impl : string
val option_intf : string
val option_text : string
val display_custom_generators_dir : string
val add_load_dir : string
val load_file : string
val werr : string
val show_missed_crossref : string
val hide_warnings : string
val target_dir : string
val dump : string
val load : string
val css_style : string
val index_only : string
val colorize_code : string
val html_short_functors : string
val charset : string -> string
val no_navbar : string
val generate_html : string
val generate_latex : string
val generate_texinfo : string
val generate_man : string
val generate_dot : string
val option_not_in_native_code : string -> string
val default_out_file : string
val out_file : string
val dot_include_all : string
val dot_types : string
val default_dot_colors : string list list
val dot_colors : string
val dot_reduce : string
val man_mini : string
val default_man_section : string
val man_section : string
val default_man_suffix : string
val man_suffix : string
val option_title : string
val option_intro : string
val with_parameter_list : string
val hide_modules : string
val no_header : string
val no_trailer : string
val separate_files : string
val latex_title : (int * string) list ref -> string
val default_latex_value_prefix : string
val latex_value_prefix : string
val default_latex_type_prefix : string
val latex_type_prefix : string
val default_latex_type_elt_prefix : string
val latex_type_elt_prefix : string
val default_latex_extension_prefix : string
val latex_extension_prefix : string
val default_latex_exception_prefix : string
val latex_exception_prefix : string
val default_latex_module_prefix : string
val latex_module_prefix : string
val default_latex_module_type_prefix : string
val latex_module_type_prefix : string
val default_latex_class_prefix : string
val latex_class_prefix : string
val default_latex_class_type_prefix : string
val latex_class_type_prefix : string
val default_latex_attribute_prefix : string
val latex_attribute_prefix : string
val default_latex_method_prefix : string
val latex_method_prefix : string
val no_toc : string
val sort_modules : string
val no_stop : string
val no_custom_tags : string
val remove_stars : string
val keep_code : string
val inverse_merge_ml_mli : string
val no_filter_with_module_constraints : string
val merge_description : char * string
val merge_author : char * string
val merge_version : char * string
val merge_see : char * string
val merge_since : char * string
val merge_before : char * string
val merge_deprecated : char * string
val merge_param : char * string
val merge_raised_exception : char * string
val merge_return_value : char * string
val merge_custom : char * string
val merge_all : char * string
val no_index : string
val esc_8bits : string
val texinfo_title : (int * (string * string)) list ref -> string
val info_section : string
val info_entry : string
val options_can_be : string
val string_of_options_list : (char * string) list -> string
val merge_options : string
val initially_opened_module : string
val library_namespace : string
val help : string
val warning : string
val error_location : string -> int -> int -> string
val bad_magic_number : string
val not_a_module_name : string -> string
val load_file_error : string -> string -> string
val wrong_format : string -> string
val errors_occured : int -> string
val parse_error : string
val text_parse_error : int -> int -> string -> string
val file_not_found_in_paths : string list -> string -> string
val tag_not_handled : string -> string
val should_escape_at_sign : string
val bad_tree : string
val not_a_valid_tag : string -> string
val fun_without_param : string -> string
val method_without_param : string -> string
val anonymous_parameters : string -> string
val function_colon : string -> string
val implicit_match_in_parameter : string
val unknown_extension : string -> string
val two_implementations : string -> string
val two_interfaces : string -> string
val too_many_module_objects : string -> string
val extension_not_found_in_implementation : string -> string -> string
val exception_not_found_in_implementation : string -> string -> string
val type_not_found_in_implementation : string -> string -> string
val module_not_found_in_implementation : string -> string -> string
val value_not_found_in_implementation : string -> string -> string
val class_not_found_in_implementation : string -> string -> string
val attribute_not_found_in_implementation : string -> string -> string
val method_not_found_in_implementation : string -> string -> string
val different_types : string -> string
val attribute_type_not_found : string -> string -> string
val method_type_not_found : string -> string -> string
val module_not_found : string -> string -> string
val module_type_not_found : string -> string -> string
val value_not_found : string -> string -> string
val extension_not_found : string -> string -> string
val exception_not_found : string -> string -> string
val type_not_found : string -> string -> string
val class_not_found : string -> string -> string
val class_type_not_found : string -> string -> string
val type_not_found_in_typedtree : string -> string
val extension_not_found_in_typedtree : string -> string
val exception_not_found_in_typedtree : string -> string
val module_type_not_found_in_typedtree : string -> string
val module_not_found_in_typedtree : string -> string
val class_not_found_in_typedtree : string -> string
val class_type_not_found_in_typedtree : string -> string
val inherit_classexp_not_found_in_typedtree : int -> string
val attribute_not_found_in_typedtree : string -> string
val method_not_found_in_typedtree : string -> string
val misplaced_comment : string -> int -> string
val cross_module_not_found : string -> string
val cross_module_type_not_found : string -> string
val cross_module_or_module_type_not_found : string -> string
val cross_class_not_found : string -> string
val cross_class_type_not_found : string -> string
val cross_class_or_class_type_not_found : string -> string
val cross_extension_not_found : string -> string
val cross_exception_not_found : string -> string
val cross_element_not_found : string -> string
val cross_method_not_found : string -> string
val cross_attribute_not_found : string -> string
val cross_section_not_found : string -> string
val cross_value_not_found : string -> string
val cross_type_not_found : string -> string
val cross_recfield_not_found : string -> string
val cross_const_not_found : string -> string
val code_could_be_cross_reference : string -> string -> string
val object_end : string
val struct_end : string
val sig_end : string
val current_generator_is_not : string -> string
val analysing : string -> string
val merging : string
val cross_referencing : string
val generating_doc : string
val loading : string -> string
val file_generated : string -> string
val file_exists_dont_generate : string -> string
val modul : string
val modules : string
val functors : string
val values : string
val types : string
val extensions : string
val exceptions : string
val record : string
val variant : string
val mutab : string
val functions : string
val parameters : string
val abstract : string
val functo : string
val clas : string
val classes : string
val attributes : string
val methods : string
val authors : string
val version : string
val since : string
val before : string
val deprecated : string
val alert : string
val raises : string
val returns : string
val inherits : string
val inheritance : string
val privat : string
val module_type : string
val class_type : string
val description : string
val interface : string
val type_parameters : string
val class_types : string
val module_types : string
val see_also : string
val documentation : string
val index_of : string
val top : string
val index_of_values : string
val index_of_extensions : string
val index_of_exceptions : string
val index_of_types : string
val index_of_attributes : string
val index_of_methods : string
val index_of_classes : string
val index_of_class_types : string
val index_of_modules : string
val index_of_module_types : string
val previous : string
val next : string
val up : string
\ No newline at end of file +Odoc_messages (ocaml.Odoc_messages)

Module Odoc_messages

The messages of the application.

val ok : string
val software : string
val config_version : string
val magic : string
val usage : string
val options_are : string
val latex_only : string
val texi_only : string
val latex_texi_only : string
val html_only : string
val html_latex_only : string
val html_latex_texi_only : string
val man_only : string
val option_impl : string
val option_intf : string
val option_text : string
val display_custom_generators_dir : string
val add_load_dir : string
val load_file : string
val werr : string
val show_missed_crossref : string
val hide_warnings : string
val target_dir : string
val dump : string
val load : string
val css_style : string
val index_only : string
val colorize_code : string
val html_short_functors : string
val charset : string -> string
val no_navbar : string
val generate_html : string
val generate_latex : string
val generate_texinfo : string
val generate_man : string
val generate_dot : string
val option_not_in_native_code : string -> string
val default_out_file : string
val out_file : string
val dot_include_all : string
val dot_types : string
val default_dot_colors : string list list
val dot_colors : string
val dot_reduce : string
val man_mini : string
val default_man_section : string
val man_section : string
val default_man_suffix : string
val man_suffix : string
val option_title : string
val option_intro : string
val with_parameter_list : string
val hide_modules : string
val no_header : string
val no_trailer : string
val separate_files : string
val latex_title : (int * string) list Stdlib.ref -> string
val default_latex_value_prefix : string
val latex_value_prefix : string
val default_latex_type_prefix : string
val latex_type_prefix : string
val default_latex_type_elt_prefix : string
val latex_type_elt_prefix : string
val default_latex_extension_prefix : string
val latex_extension_prefix : string
val default_latex_exception_prefix : string
val latex_exception_prefix : string
val default_latex_module_prefix : string
val latex_module_prefix : string
val default_latex_module_type_prefix : string
val latex_module_type_prefix : string
val default_latex_class_prefix : string
val latex_class_prefix : string
val default_latex_class_type_prefix : string
val latex_class_type_prefix : string
val default_latex_attribute_prefix : string
val latex_attribute_prefix : string
val default_latex_method_prefix : string
val latex_method_prefix : string
val no_toc : string
val sort_modules : string
val no_stop : string
val no_custom_tags : string
val remove_stars : string
val keep_code : string
val inverse_merge_ml_mli : string
val no_filter_with_module_constraints : string
val merge_description : char * string
val merge_author : char * string
val merge_version : char * string
val merge_see : char * string
val merge_since : char * string
val merge_before : char * string
val merge_deprecated : char * string
val merge_param : char * string
val merge_raised_exception : char * string
val merge_return_value : char * string
val merge_custom : char * string
val merge_all : char * string
val no_index : string
val esc_8bits : string
val texinfo_title : (int * (string * string)) list Stdlib.ref -> string
val info_section : string
val info_entry : string
val options_can_be : string
val string_of_options_list : (char * string) list -> string
val merge_options : string
val initially_opened_module : string
val library_namespace : string
val help : string
val warning : string
val error_location : string -> int -> int -> string
val bad_magic_number : string
val not_a_module_name : string -> string
val load_file_error : string -> string -> string
val wrong_format : string -> string
val errors_occured : int -> string
val parse_error : string
val text_parse_error : int -> int -> string -> string
val file_not_found_in_paths : string list -> string -> string
val tag_not_handled : string -> string
val should_escape_at_sign : string
val bad_tree : string
val not_a_valid_tag : string -> string
val fun_without_param : string -> string
val method_without_param : string -> string
val anonymous_parameters : string -> string
val function_colon : string -> string
val implicit_match_in_parameter : string
val unknown_extension : string -> string
val two_implementations : string -> string
val two_interfaces : string -> string
val too_many_module_objects : string -> string
val extension_not_found_in_implementation : string -> string -> string
val exception_not_found_in_implementation : string -> string -> string
val type_not_found_in_implementation : string -> string -> string
val module_not_found_in_implementation : string -> string -> string
val value_not_found_in_implementation : string -> string -> string
val class_not_found_in_implementation : string -> string -> string
val attribute_not_found_in_implementation : string -> string -> string
val method_not_found_in_implementation : string -> string -> string
val different_types : string -> string
val attribute_type_not_found : string -> string -> string
val method_type_not_found : string -> string -> string
val module_not_found : string -> string -> string
val module_type_not_found : string -> string -> string
val value_not_found : string -> string -> string
val extension_not_found : string -> string -> string
val exception_not_found : string -> string -> string
val type_not_found : string -> string -> string
val class_not_found : string -> string -> string
val class_type_not_found : string -> string -> string
val type_not_found_in_typedtree : string -> string
val extension_not_found_in_typedtree : string -> string
val exception_not_found_in_typedtree : string -> string
val module_type_not_found_in_typedtree : string -> string
val module_not_found_in_typedtree : string -> string
val class_not_found_in_typedtree : string -> string
val class_type_not_found_in_typedtree : string -> string
val inherit_classexp_not_found_in_typedtree : int -> string
val attribute_not_found_in_typedtree : string -> string
val method_not_found_in_typedtree : string -> string
val misplaced_comment : string -> int -> string
val cross_module_not_found : string -> string
val cross_module_type_not_found : string -> string
val cross_module_or_module_type_not_found : string -> string
val cross_class_not_found : string -> string
val cross_class_type_not_found : string -> string
val cross_class_or_class_type_not_found : string -> string
val cross_extension_not_found : string -> string
val cross_exception_not_found : string -> string
val cross_element_not_found : string -> string
val cross_method_not_found : string -> string
val cross_attribute_not_found : string -> string
val cross_section_not_found : string -> string
val cross_value_not_found : string -> string
val cross_type_not_found : string -> string
val cross_recfield_not_found : string -> string
val cross_const_not_found : string -> string
val code_could_be_cross_reference : string -> string -> string
val object_end : string
val struct_end : string
val sig_end : string
val current_generator_is_not : string -> string
val analysing : string -> string
val merging : string
val cross_referencing : string
val generating_doc : string
val loading : string -> string
val file_generated : string -> string
val file_exists_dont_generate : string -> string
val modul : string
val modules : string
val functors : string
val values : string
val types : string
val extensions : string
val exceptions : string
val record : string
val variant : string
val mutab : string
val functions : string
val parameters : string
val abstract : string
val functo : string
val clas : string
val classes : string
val attributes : string
val methods : string
val authors : string
val version : string
val since : string
val before : string
val deprecated : string
val alert : string
val raises : string
val returns : string
val inherits : string
val inheritance : string
val privat : string
val module_type : string
val class_type : string
val description : string
val interface : string
val type_parameters : string
val class_types : string
val module_types : string
val see_also : string
val documentation : string
val index_of : string
val top : string
val index_of_values : string
val index_of_extensions : string
val index_of_exceptions : string
val index_of_types : string
val index_of_attributes : string
val index_of_methods : string
val index_of_classes : string
val index_of_class_types : string
val index_of_modules : string
val index_of_module_types : string
val previous : string
val next : string
val up : string
\ No newline at end of file diff --git a/ocaml/Profiling/index.html b/ocaml/Profiling/index.html index c976ed0..f083385 100644 --- a/ocaml/Profiling/index.html +++ b/ocaml/Profiling/index.html @@ -1,2 +1,2 @@ -Profiling (ocaml.Profiling)

Module Profiling

val counters : (string * (string * int array)) list ref
val incr : int array -> int -> unit
\ No newline at end of file +Profiling (ocaml.Profiling)

Module Profiling

val counters : (string * (string * int array)) list Stdlib.ref
val incr : int array -> int -> unit
\ No newline at end of file diff --git a/ocaml/Terminfo/index.html b/ocaml/Terminfo/index.html index c136453..19e9d83 100644 --- a/ocaml/Terminfo/index.html +++ b/ocaml/Terminfo/index.html @@ -1,2 +1,2 @@ -Terminfo (ocaml.Terminfo)

Module Terminfo

Basic interface to the terminfo database

Warning: this module is unstable and part of compiler-libs.

type status =
  1. | Uninitialised
  2. | Bad_term
  3. | Good_term
val setup : out_channel -> status
val num_lines : out_channel -> int
val backup : out_channel -> int -> unit
val standout : out_channel -> bool -> unit
val resume : out_channel -> int -> unit
\ No newline at end of file +Terminfo (ocaml.Terminfo)

Module Terminfo

Basic interface to the terminfo database

Warning: this module is unstable and part of compiler-libs.

type status =
  1. | Uninitialised
  2. | Bad_term
  3. | Good_term
val setup : Stdlib.out_channel -> status
val num_lines : Stdlib.out_channel -> int
val backup : Stdlib.out_channel -> int -> unit
val standout : Stdlib.out_channel -> bool -> unit
val resume : Stdlib.out_channel -> int -> unit
\ No newline at end of file diff --git a/ocaml/X86_gas/index.html b/ocaml/X86_gas/index.html index cd47342..04ce355 100644 --- a/ocaml/X86_gas/index.html +++ b/ocaml/X86_gas/index.html @@ -1,2 +1,2 @@ -X86_gas (ocaml.X86_gas)

Module X86_gas

Emit assembly instructions for gas.

val generate_asm : out_channel -> X86_ast.asm_line list -> unit
\ No newline at end of file +X86_gas (ocaml.X86_gas)

Module X86_gas

Emit assembly instructions for gas.

val generate_asm : Stdlib.out_channel -> X86_ast.asm_line list -> unit
\ No newline at end of file diff --git a/ocaml/X86_masm/index.html b/ocaml/X86_masm/index.html index 0f57588..23bfecf 100644 --- a/ocaml/X86_masm/index.html +++ b/ocaml/X86_masm/index.html @@ -1,2 +1,2 @@ -X86_masm (ocaml.X86_masm)

Module X86_masm

Emit assembly instructions for MASM (Intel syntax).

val generate_asm : out_channel -> X86_ast.asm_line list -> unit
\ No newline at end of file +X86_masm (ocaml.X86_masm)

Module X86_masm

Emit assembly instructions for MASM (Intel syntax).

val generate_asm : Stdlib.out_channel -> X86_ast.asm_line list -> unit
\ No newline at end of file diff --git a/trace/Trace/index.html b/trace/Trace/index.html index 3b7ddd6..68d4dae 100644 --- a/trace/Trace/index.html +++ b/trace/Trace/index.html @@ -24,7 +24,7 @@ ?data:(unit -> (string * user_data) list) -> string -> explicit_span

Like with_span but the caller is responsible for obtaining the parent span from their own caller, and carry the resulting explicit_span to the matching exit_manual_span.

NOTE this replaces enter_manual_sub_span and enter_manual_toplevel_span by just making parent an explicit option. It is breaking anyway because we now pass an explicit_span_ctx instead of a full explicit_span (the reason being that we might receive this explicit_span_ctx from another process or machine).

val enter_manual_sub_span : - parent:explicit_span_ctx -> + parent:explicit_span -> ?flavor:[ `Sync | `Async ] -> ?level:Level.t -> ?__FUNCTION__:string -> diff --git a/trace/Trace_core/index.html b/trace/Trace_core/index.html index 94215dc..ceeeab7 100644 --- a/trace/Trace_core/index.html +++ b/trace/Trace_core/index.html @@ -24,7 +24,7 @@ ?data:(unit -> (string * user_data) list) -> string -> explicit_span

Like with_span but the caller is responsible for obtaining the parent span from their own caller, and carry the resulting explicit_span to the matching exit_manual_span.

NOTE this replaces enter_manual_sub_span and enter_manual_toplevel_span by just making parent an explicit option. It is breaking anyway because we now pass an explicit_span_ctx instead of a full explicit_span (the reason being that we might receive this explicit_span_ctx from another process or machine).

  • parameter flavor

    a description of the span that can be used by the Collector.S to decide how to represent the span. Typically, `Sync spans start and stop on one thread, and are nested purely by their timestamp; and `Async spans can overlap, migrate between threads, etc. (as happens in Lwt, Eio, Async, etc.) which impacts how the collector might represent them.

  • parameter level

    optional level for this span. since 0.7. Default is set via set_default_level.

  • since NEXT_RELEASE
val enter_manual_sub_span : - parent:explicit_span_ctx -> + parent:explicit_span -> ?flavor:[ `Sync | `Async ] -> ?level:Level.t -> ?__FUNCTION__:string ->