Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
icristescu committed Sep 28, 2022
1 parent d186f7f commit ae959a3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/irmin-pack/unix/s.ml
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ module type S = sig
Finalising consists of mutating [repo] so that it points to the new file
and to flush the internal caches that could be referencing GCed objects.
If [wait = true] (the default), the call blocks until the GC process
finishes. If [wait = false], finalisation will occur if the process has
ended.
If [wait = true] (the default), the calling process blocks until the GC
process finishes. If [wait = false], finalisation will occur if the
process has ended.
If there are no running GCs, the call is a no-op and it returns [`Idle].
Expand Down Expand Up @@ -119,7 +119,7 @@ module type S = sig
messages should be used only for informational purposes, like logging. *)

val wait : repo -> (stats option, msg) result Lwt.t
(** [wait repo] blocks until GC is finished or is idle.
(** [wait repo] blocks the process until GC is finished or is idle.
If a GC finalises, its stats are returned.
Expand Down

0 comments on commit ae959a3

Please sign in to comment.