From 423d63435c96378ae186431153d20f447ab83cc0 Mon Sep 17 00:00:00 2001 From: Calascibetta Romain Date: Mon, 20 May 2024 10:05:03 +0200 Subject: [PATCH] Add a non-explicit note about terminal.ansi & unikernels and how to avoid the unix dependency from this library to progress.engine --- src/terminal/ansi/terminal_ansi.mli | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/terminal/ansi/terminal_ansi.mli b/src/terminal/ansi/terminal_ansi.mli index 149eef1..f7be16a 100644 --- a/src/terminal/ansi/terminal_ansi.mli +++ b/src/terminal/ansi/terminal_ansi.mli @@ -4,7 +4,17 @@ ————————————————————————————————————————————————————————————————————————————*) (** This library provides a small set of standard utility functions for - interacting with terminals. *) + interacting with terminals. + + Note that this module does not depend on the [unix] library. There is + therefore a way to use [Terminal_ansi] and [progress.engine] in a context + other than a POSIX system (such as a unikernel). To do this, you need to + compose [Terminal_ansi] with a library that looks like [terminal.unix] + (which should allow you to obtain the size of a TTY). It would then be + sufficient to compose the latter (just as the [terminal] library does) to + then be able to use [Progess_engine.Make] with the result of this + composition. +*) module Color : sig type t