Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix stdlib mlis #178

Merged
merged 3 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions stdlib/atomic.mli
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,6 @@
See {{!examples} the examples} below.
See 'Memory model: The hard bits' chapter in the manual.

<<<<<<< HEAD
This sequential implementation is provided in the interest of
compatibility: when people will start writing code to run on
Multicore, it would be nice if their use of Atomic was
backward-compatible with older versions of OCaml without having to
import additional compatibility layers.

||||||| merged common ancestors
This sequential implementation is provided in the interest of
compatibility: when people will start writing code to run on
Multicore, it would be nice if their use of Atomic was
backward-compatible with older versions of OCaml without having to
import additional compatibility layers. *)
=======
>>>>>>> ocaml/5.1
@since 4.12
*)

Expand Down
6 changes: 0 additions & 6 deletions stdlib/bigarray.mli
Original file line number Diff line number Diff line change
Expand Up @@ -975,13 +975,7 @@ external genarray_of_array0 :
('a, 'b, 'c) Array0.t -> ('a, 'b, 'c) Genarray.t = "%identity"
(** Return the generic Bigarray corresponding to the given zero-dimensional
Bigarray.
<<<<<<< HEAD
@since 4.05.0 *)
||||||| merged common ancestors
Bigarray. @since 4.05.0 *)
=======
@since 4.05 *)
>>>>>>> ocaml/5.1

external genarray_of_array1 :
('a, 'b, 'c) Array1.t -> ('a, 'b, 'c) Genarray.t = "%identity"
Expand Down
5 changes: 1 addition & 4 deletions stdlib/buffer.mli
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,8 @@ open! Stdlib

*)

<<<<<<< HEAD
[@@@ocaml.warning "A"]
||||||| merged common ancestors
=======

(** {b Unsynchronized accesses} *)

[@@@alert unsynchronized_access
Expand All @@ -48,7 +46,6 @@ open! Stdlib
Thus, concurrent accesses to a buffer must be synchronized (for instance
with a {!Mutex.t}).
*)
>>>>>>> ocaml/5.1

type t
(** The abstract type of buffers. *)
Expand Down
17 changes: 0 additions & 17 deletions stdlib/float.mli
Original file line number Diff line number Diff line change
Expand Up @@ -117,22 +117,6 @@ val nan : float
IEEE 754 standard. As for floating-point comparisons,
[=], [<], [<=], [>] and [>=] return [false] and [<>] returns [true]
if one or both of their arguments is [nan].
<<<<<<< HEAD
Returns [quiet_nan] since 5.0.0. *)

val signaling_nan : float
(** Signaling NaN. The corresponding signals do not raise OCaml exception,
but the value can be useful for interop with C libraries.

@since 5.0.0 *)

val quiet_nan : float
(** Quiet NaN.

@since 5.0.0 *)
||||||| merged common ancestors
if one or both of their arguments is [nan]. *)
=======

[nan] is [quiet_nan] since 5.1; it was a signaling NaN before. *)

Expand All @@ -146,7 +130,6 @@ val quiet_nan : float
(** Quiet NaN.

@since 5.1 *)
>>>>>>> ocaml/5.1

val pi : float
(** The constant pi. *)
Expand Down
5 changes: 2 additions & 3 deletions stdlib/gc.ml
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,8 @@ external major : unit -> unit = "caml_gc_major"
external full_major : unit -> unit = "caml_gc_full_major"
external compact : unit -> unit = "caml_gc_compaction"
external get_minor_free : unit -> int = "caml_get_minor_free"

let eventlog_pause () = ()
let eventlog_resume () = ()
external eventlog_pause : unit -> unit = "caml_eventlog_pause"
external eventlog_resume : unit -> unit = "caml_eventlog_resume"

open Printf

Expand Down
49 changes: 4 additions & 45 deletions stdlib/gc.mli
Original file line number Diff line number Diff line change
Expand Up @@ -95,26 +95,16 @@ type stat =

stack_size: int;
(** Current size of the stack, in words.
<<<<<<< HEAD
@since 3.12.0 *)
||||||| merged common ancestors
(** Current size of the stack, in words. @since 3.12.0 *)
=======
This metrics is currently not available in OCaml 5: the field value is
always [0].

This metrics will not be available in the OCaml 5 runtime: the field
value will always be [0].

@since 3.12 *)
>>>>>>> ocaml/5.1

forced_major_collections: int;
(** Number of forced full major collections completed since the program
was started.
<<<<<<< HEAD
@since 4.12.0 *)
||||||| merged common ancestors
was started. @since 4.12.0 *)
=======
@since 4.12 *)
>>>>>>> ocaml/5.1
}
(** The memory management counters are returned in a [stat] record. These
counters give values for the whole program.
Expand Down Expand Up @@ -221,13 +211,7 @@ type control =
out variations in its workload. This is an integer between
1 and 50.
Default: 1.
<<<<<<< HEAD
@since 4.03.0 *)
||||||| merged common ancestors
Default: 1. @since 4.03.0 *)
=======
@since 4.03 *)
>>>>>>> ocaml/5.1

custom_major_ratio : int;
(** Target ratio of floating garbage to major heap size for
Expand Down Expand Up @@ -449,7 +433,6 @@ val delete_alarm : alarm -> unit
(** [delete_alarm a] will stop the calls to the function associated
to [a]. Calling [delete_alarm a] again has no effect. *)

<<<<<<< HEAD
goldfirere marked this conversation as resolved.
Show resolved Hide resolved
external eventlog_pause : unit -> unit = "caml_eventlog_pause"
(** [eventlog_pause ()] will pause the collection of traces in the
runtime.
Expand All @@ -472,30 +455,6 @@ external eventlog_resume : unit -> unit = "caml_eventlog_resume"

@since 4.11
*)
||||||| merged common ancestors
external eventlog_pause : unit -> unit = "caml_eventlog_pause"
(** [eventlog_pause ()] will pause the collection of traces in the
runtime.
Traces are collected if the program is linked to the instrumented runtime
and started with the environment variable OCAML_EVENTLOG_ENABLED.
Events are flushed to disk after pausing, and no new events will be
recorded until [eventlog_resume] is called. *)

external eventlog_resume : unit -> unit = "caml_eventlog_resume"
(** [eventlog_resume ()] will resume the collection of traces in the
runtime.
Traces are collected if the program is linked to the instrumented runtime
and started with the environment variable OCAML_EVENTLOG_ENABLED.
This call can be used after calling [eventlog_pause], or if the program
was started with OCAML_EVENTLOG_ENABLED=p. (which pauses the collection of
traces before the first event.) *)
=======
val eventlog_pause : unit -> unit
[@@ocaml.deprecated "Use Runtime_events.pause instead."]
>>>>>>> ocaml/5.1

val eventlog_resume : unit -> unit
[@@ocaml.deprecated "Use Runtime_events.resume instead."]

(** [Memprof] is a sampling engine for allocated memory words. Every
allocated word has a probability of being sampled equal to a
Expand Down
12 changes: 1 addition & 11 deletions stdlib/hashtbl.mli
Original file line number Diff line number Diff line change
Expand Up @@ -440,19 +440,9 @@ module type SeededHashedType =
val seeded_hash: int -> t -> int
(** A seeded hashing function on keys. The first argument is
the seed. It must be the case that if [equal x y] is true,
<<<<<<< HEAD
then [hash seed x = hash seed y] for any value of [seed].
A suitable choice for [hash] is the function
{!Stdlib.Hashtbl.seeded_hash} below. *)
||||||| merged common ancestors
then [hash seed x = hash seed y] for any value of [seed].
A suitable choice for [hash] is the function {!seeded_hash}
below. *)
=======
then [seeded_hash seed x = seeded_hash seed y] for any value of
[seed]. A suitable choice for [seeded_hash] is the function
{!Hashtbl.seeded_hash} below. *)
>>>>>>> ocaml/5.1
{!Stdlib.Hashtbl.seeded_hash} below. *)
end
(** The input signature of the functor {!MakeSeeded}.
@since 4.00 *)
Expand Down
8 changes: 0 additions & 8 deletions stdlib/in_channel.mli
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@

(** Input channels.

<<<<<<< HEAD
@since 4.14.0 *)
open! Stdlib
||||||| merged common ancestors
@since 4.14.0 *)

=======
This module provides functions for working with input channels.

See {{!examples} the example section} below.
Expand All @@ -30,7 +23,6 @@ open! Stdlib

(** {1:channels Channels} *)

>>>>>>> ocaml/5.1
type t = in_channel
(** The type of input channel. *)

Expand Down
11 changes: 0 additions & 11 deletions stdlib/int32.mli
Original file line number Diff line number Diff line change
Expand Up @@ -242,15 +242,4 @@ val hash : t -> int
{!Hashtbl.hash}. This function allows this module to be passed as argument
to the functor {!Hashtbl.Make}.

<<<<<<< HEAD
external format : string -> int32 -> string = "caml_int32_format"
[@@ocaml.deprecated "Use Printf.sprintf with a [%l...] format instead."]
(** Do not use this deprecated function. Instead,
used {!Printf.sprintf} with a [%l...] format. *)
||||||| merged common ancestors
external format : string -> int32 -> string = "caml_int32_format"
(** Do not use this deprecated function. Instead,
used {!Printf.sprintf} with a [%l...] format. *)
=======
@since 5.1 *)
>>>>>>> ocaml/5.1
11 changes: 0 additions & 11 deletions stdlib/int64.mli
Original file line number Diff line number Diff line change
Expand Up @@ -256,20 +256,9 @@ val seeded_hash : int -> t -> int

@since 5.1 *)

<<<<<<< HEAD
external format : string -> int64 -> string = "caml_int64_format"
[@@ocaml.deprecated "Use Printf.sprintf with a [%L...] format instead."]
(** Do not use this deprecated function. Instead,
used {!Printf.sprintf} with a [%L...] format. *)
||||||| merged common ancestors
external format : string -> int64 -> string = "caml_int64_format"
(** Do not use this deprecated function. Instead,
used {!Printf.sprintf} with a [%L...] format. *)
=======
val hash : t -> int
(** An unseeded hash function for 64-bit ints, with the same output value as
{!Hashtbl.hash}. This function allows this module to be passed as argument
to the functor {!Hashtbl.Make}.

@since 5.1 *)
>>>>>>> ocaml/5.1
Loading