Something went wrong. Try again.
Odoc docs forked from jon.recoil.org/odd
Something went wrong. Try again.
123456789101112131415161718192021(** Stale markers: the set of packages whose documentation is out of date.
A package is marked by the empty file [<prefix>/odoc/<name>/.odd-stale]. The opam post-install hook creates it with a plain [mkdir -p] + [touch], so recording a change needs no odd binary in the switch — only [sync] (and [rebuild]) do. Removals are handled directly by the post-remove hook ([rm -rf] of the package's doc directory), which also clears any marker, so there is no remove marker. *)
val marker : Switch.t -> string -> Fpath.t(** [<prefix>/odoc/<name>/.odd-stale]. *)
val read : Switch.t -> string list(** Names of packages with a stale marker — the subdirectories of [<prefix>/odoc] containing a {!marker} — sorted. *)
val mark : Switch.t -> string -> (unit, [ `Msg of string ]) result(** Create the stale marker for a package, [mkdir -p]-ing its doc directory first. Used by [rebuild] and by [sync] to keep a package pending after a failed build. *)