package obuilder

You can search for identifiers within the package.

in-package search v0.2.0

Run build scripts for CI

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

T

talex5@gmail.com

Maintainers

T

talex5@gmail.com

Sources

obuilder-spec-v0.3.tbz

sha256=43473944fefea40e80cfa18461e23e69b5c3b81add828a70250d085bc794d62d

sha512=4c523440945f69552d7defd0f453777b4f7204b17ec67de366ad8f77efdc3e08c938beda117d5b8585fea4767a2c95a52f48939024ae8d811af8a16e85d84646

doc/obuilder/Obuilder/Build_log/index.html

Module `Obuilder.Build_log`Source

Sourcetype t

The log for a single build step.

Creating logs

Sourceval create : string -> t Lwt.t

create path creates a new log file at temporary location path. Call finish when done to release the file descriptor.

Sourceval finish : t -> unit Lwt.t

finish t marks log t as finished. If it was open for writing, this closes the file descriptor. It cannot be used after this (for reading or writing), although existing background operations (e.g. tail) can continue successfully.

Sourceval write : t -> string -> unit Lwt.t

write t data appends data to the log.

Sourceval printf : t -> ('a, Format.formatter, unit, unit Lwt.t) format4 -> 'a

printf t fmt is a wrapper for write t that takes a format string.

Reading logs

Sourceval empty : t

empty is a read-only log with no content.

Sourceval of_saved : string -> t Lwt.t

of_saved path is a read-only log which reads from path.

Source

val tail : 
  ?switch:Lwt_switch.t ->
  t ->
  (string -> unit) ->
  (unit, [> `Cancelled ]) Lwt_result.t

tail t dst streams data from the log to dst. This can be called at any time before finish is called.

parameter switch
Abort if this is turned off.

On This Page

Creating logs
Reading logs