diff --git a/jsonrpc/_doc-dir/CHANGES.md b/jsonrpc/_doc-dir/CHANGES.md index efb704fe..2534ba12 100644 --- a/jsonrpc/_doc-dir/CHANGES.md +++ b/jsonrpc/_doc-dir/CHANGES.md @@ -1,3 +1,17 @@ +# 1.22.0 + +## Features + +- Enable experimental project-wide renaming of identifiers (#1431) + +# 1.21.0 + +## Features + +- Add a new server option `standardHover`, that can be used by clients to + disable the default hover provider. When `standardHover = false` + `textDocument/hover` requests always returns with empty result. (#1416) + # 1.20.1 ## Fixes @@ -14,6 +28,7 @@ [`ocamllsp/typeSearch`](/ocaml-lsp-server/docs/ocamllsp/typeSearch-spec.md) request (#1369) - Make MerlinJump code action configurable (#1376) +- Add support for OCaml 5.3 (#1386) - Add custom [`ocamllsp/jump`](/ocaml-lsp-server/docs/ocamllsp/merlinJump-spec.md) request (#1374) diff --git a/jsonrpc/_doc-dir/README.md b/jsonrpc/_doc-dir/README.md index 84359648..d653aa8c 100644 --- a/jsonrpc/_doc-dir/README.md +++ b/jsonrpc/_doc-dir/README.md @@ -182,7 +182,7 @@ Semantic highlighting support is enabled by default. > since OCaml-LSP 1.14.0 OCaml-LSP implements experimental semantic highlighting support (also known as -semantic tokens support). The support can be activated by passing an evironment +semantic tokens support). The support can be activated by passing an environment variable to OCaml-LSP: - To enable non-incremental (expectedly slower but more stable) version, pass @@ -245,7 +245,7 @@ type t = A | B of string option let f (v : t) = match v with | A -> _ | B (None) | B (Some _) -> _ ``` -Importantly, note the undescores in place of expressions in each branch of the +Importantly, note the underscores in place of expressions in each branch of the pattern match above. The underscores that occur in place of expressions are called "typed holes" - a concept explained below. diff --git a/lsp/_doc-dir/CHANGES.md b/lsp/_doc-dir/CHANGES.md index efb704fe..2534ba12 100644 --- a/lsp/_doc-dir/CHANGES.md +++ b/lsp/_doc-dir/CHANGES.md @@ -1,3 +1,17 @@ +# 1.22.0 + +## Features + +- Enable experimental project-wide renaming of identifiers (#1431) + +# 1.21.0 + +## Features + +- Add a new server option `standardHover`, that can be used by clients to + disable the default hover provider. When `standardHover = false` + `textDocument/hover` requests always returns with empty result. (#1416) + # 1.20.1 ## Fixes @@ -14,6 +28,7 @@ [`ocamllsp/typeSearch`](/ocaml-lsp-server/docs/ocamllsp/typeSearch-spec.md) request (#1369) - Make MerlinJump code action configurable (#1376) +- Add support for OCaml 5.3 (#1386) - Add custom [`ocamllsp/jump`](/ocaml-lsp-server/docs/ocamllsp/merlinJump-spec.md) request (#1374) diff --git a/lsp/_doc-dir/README.md b/lsp/_doc-dir/README.md index 84359648..d653aa8c 100644 --- a/lsp/_doc-dir/README.md +++ b/lsp/_doc-dir/README.md @@ -182,7 +182,7 @@ Semantic highlighting support is enabled by default. > since OCaml-LSP 1.14.0 OCaml-LSP implements experimental semantic highlighting support (also known as -semantic tokens support). The support can be activated by passing an evironment +semantic tokens support). The support can be activated by passing an environment variable to OCaml-LSP: - To enable non-incremental (expectedly slower but more stable) version, pass @@ -245,7 +245,7 @@ type t = A | B of string option let f (v : t) = match v with | A -> _ | B (None) | B (Some _) -> _ ``` -Importantly, note the undescores in place of expressions in each branch of the +Importantly, note the underscores in place of expressions in each branch of the pattern match above. The underscores that occur in place of expressions are called "typed holes" - a concept explained below. diff --git a/trace/Trace/index.html b/trace/Trace/index.html index 6631bbbe..f5339301 100644 --- a/trace/Trace/index.html +++ b/trace/Trace/index.html @@ -54,4 +54,4 @@ ?data:(unit -> (string * user_data) list) -> string -> float -> - unit

Emit a counter of type float. See counter_int for more details.

Collector

type collector = (module Collector.S)

An event collector.

See Collector for more details.

val setup_collector : collector -> unit

setup_collector c installs c as the current collector.

val get_current_level : unit -> Level.t

Get current level. This is only meaningful if a collector was set up with setup_collector.

val set_current_level : Level.t -> unit

Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

val shutdown : unit -> unit

shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

+ unit

Emit a counter of type float. See counter_int for more details.

Collector

type collector = (module Collector.S)

An event collector.

See Collector for more details.

val setup_collector : collector -> unit

setup_collector c installs c as the current collector.

val get_current_level : unit -> Level.t

Get current level. This is only meaningful if a collector was set up with setup_collector.

val set_current_level : Level.t -> unit

Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

val shutdown : unit -> unit

shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

Extensions

type extension_event = ..

Extension event

val extension_event : extension_event -> unit

Trigger an extension event, whose meaning depends on the library that defines it. Some collectors will simply ignore it. This does nothing if no collector is setup.

diff --git a/trace/Trace_core/Collector/module-type-S/index.html b/trace/Trace_core/Collector/module-type-S/index.html index 9b028d58..b0e964f1 100644 --- a/trace/Trace_core/Collector/module-type-S/index.html +++ b/trace/Trace_core/Collector/module-type-S/index.html @@ -92,4 +92,4 @@ list -> string -> float -> - unit

Float counter.

val shutdown : unit -> unit

Shutdown collector, possibly waiting for it to finish sending data.

+ unit

Float counter.

val extension_event : Trace_core__.Types.extension_event -> unit

Handle an extension event. A collector MUST simple ignore events it doesn't know, and return () silently.

val shutdown : unit -> unit

Shutdown collector, possibly waiting for it to finish sending data.

diff --git a/trace/Trace_core/index.html b/trace/Trace_core/index.html index 1b00627e..789940b9 100644 --- a/trace/Trace_core/index.html +++ b/trace/Trace_core/index.html @@ -1,5 +1,5 @@ -Trace_core (trace.Trace_core)

Module Trace_core

Trace.

type span = int64

A span identifier.

The meaning of the identifier depends on the collector.

type user_data = [
  1. | `Int of int
  2. | `String of string
  3. | `Bool of bool
  4. | `Float of float
  5. | `None
]

User defined data, generally passed as key/value pairs to whatever collector is installed (if any).

type explicit_span = {
  1. span : span;
    (*

    Identifier for this span. Several explicit spans might share the same identifier since we can differentiate between them via meta.

    *)
  2. mutable meta : Meta_map.t;
    (*

    Metadata for this span (and its context). This can be used by collectors to carry collector-specific information from the beginning of the span, to the end of the span.

    *)
}

Explicit span, with collector-specific metadata

module Collector : sig ... end

A global collector.

module Meta_map : sig ... end
module Level : sig ... end

Tracing levels.

Tracing

val enabled : unit -> bool

Is there a collector?

This is fast, so that the traced program can check it before creating any span or message.

val get_default_level : unit -> Level.t

Current default level for spans.

  • since 0.7
val set_default_level : Level.t -> unit

Set level used for spans that do not specify it. The default default value is Level.Trace.

  • since 0.7
val with_span : +Trace_core (trace.Trace_core)

Module Trace_core

Trace.

type span = int64

A span identifier.

The meaning of the identifier depends on the collector.

type user_data = [
  1. | `Int of int
  2. | `String of string
  3. | `Bool of bool
  4. | `Float of float
  5. | `None
]

User defined data, generally passed as key/value pairs to whatever collector is installed (if any).

type explicit_span = {
  1. span : span;
    (*

    Identifier for this span. Several explicit spans might share the same identifier since we can differentiate between them via meta.

    *)
  2. mutable meta : Meta_map.t;
    (*

    Metadata for this span (and its context). This can be used by collectors to carry collector-specific information from the beginning of the span, to the end of the span.

    *)
}

Explicit span, with collector-specific metadata

module Collector : sig ... end

A global collector.

module Meta_map : sig ... end
module Level : sig ... end

Tracing levels.

Tracing

val enabled : unit -> bool

Is there a collector?

This is fast, so that the traced program can check it before creating any span or message.

val get_default_level : unit -> Level.t

Current default level for spans.

  • since 0.7
val set_default_level : Level.t -> unit

Set level used for spans that do not specify it. The default default value is Level.Trace.

  • since 0.7
val with_span : ?level:Level.t -> ?__FUNCTION__:string -> __FILE__:string -> @@ -54,4 +54,4 @@ ?data:(unit -> (string * user_data) list) -> string -> float -> - unit

Emit a counter of type float. See counter_int for more details.

  • parameter level

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

  • parameter data

    metadata for this metric (since 0.4)

Collector

type collector = (module Collector.S)

An event collector.

See Collector for more details.

val setup_collector : collector -> unit

setup_collector c installs c as the current collector.

  • raises Invalid_argument

    if there already is an established collector.

val get_current_level : unit -> Level.t

Get current level. This is only meaningful if a collector was set up with setup_collector.

  • since 0.7
val set_current_level : Level.t -> unit

Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

  • since 0.7
val shutdown : unit -> unit

shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

+ unit

Emit a counter of type float. See counter_int for more details.

  • parameter level

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

  • parameter data

    metadata for this metric (since 0.4)

Collector

type collector = (module Collector.S)

An event collector.

See Collector for more details.

val setup_collector : collector -> unit

setup_collector c installs c as the current collector.

  • raises Invalid_argument

    if there already is an established collector.

val get_current_level : unit -> Level.t

Get current level. This is only meaningful if a collector was set up with setup_collector.

  • since 0.7
val set_current_level : Level.t -> unit

Set the current level of tracing. This only has a visible effect if a collector was installed with setup_collector.

  • since 0.7
val shutdown : unit -> unit

shutdown () shutdowns the current collector, if one was installed, and waits for it to terminate before returning.

Extensions

type extension_event = ..

Extension event

  • since 0.8
val extension_event : extension_event -> unit

Trigger an extension event, whose meaning depends on the library that defines it. Some collectors will simply ignore it. This does nothing if no collector is setup.

  • since 0.8
diff --git a/trace/Trace_subscriber/Callbacks/Dummy/index.html b/trace/Trace_subscriber/Callbacks/Dummy/index.html index fe6f44a6..9440e728 100644 --- a/trace/Trace_subscriber/Callbacks/Dummy/index.html +++ b/trace/Trace_subscriber/Callbacks/Dummy/index.html @@ -31,4 +31,4 @@ flavor:'f -> trace_id:'g -> 'h -> - unit + unit
val on_extension_event : 'a -> time_ns:'b -> tid:'c -> 'd -> unit
diff --git a/trace/Trace_subscriber/Callbacks/module-type-S/index.html b/trace/Trace_subscriber/Callbacks/module-type-S/index.html index f5cabaed..a106a696 100644 --- a/trace/Trace_subscriber/Callbacks/module-type-S/index.html +++ b/trace/Trace_subscriber/Callbacks/module-type-S/index.html @@ -49,4 +49,9 @@ flavor:Trace_subscriber__.Types.flavor option -> trace_id:int -> Trace_core.span -> - unit

Exit a manual span

+ unit

Exit a manual span

val on_extension_event : + st -> + time_ns:float -> + tid:int -> + Trace_core.extension_event -> + unit

Extension event

diff --git a/trace/_doc-dir/CHANGES.md b/trace/_doc-dir/CHANGES.md index 2721a13e..a563d37b 100644 --- a/trace/_doc-dir/CHANGES.md +++ b/trace/_doc-dir/CHANGES.md @@ -1,3 +1,7 @@ +# 0.9 + +- add an extensible sum type, so users can implement custom events. For example + an OTEL collector can provide custom events to link two spans to one another. # 0.8