From 19a534864e2e93a1212025a9ca7e0eab0e2a2ca7 Mon Sep 17 00:00:00 2001 From: mtelvers Date: Thu, 12 Dec 2024 11:06:11 +0000 Subject: [PATCH] Final review updates --- doc/qemu.md | 11 ++++++----- lib/s.ml | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/qemu.md b/doc/qemu.md index 7943899b..1511e99c 100644 --- a/doc/qemu.md +++ b/doc/qemu.md @@ -32,16 +32,17 @@ and `autoinstall` on OpenBSD. # Operation A spec references the required base image using the `from` directive, -then runs whatever commands are required. An trivial to install the -`tar` package from opam on Windows example is given below. +then runs whatever commands are required. A trivial example which runs +`opam install tar` is given below. The `cache` directive maps an, +initially empty, folder over the opam download folder so these files +can be shared between jobs. ``` ( (from windows-server-2022-amd64-ocaml-4.14.2) (run - (run (cache (opam-archives (target "c:\\Users\\opam\\AppData\\local\\opam\\download-cache"))) - (shell "opam install tar") - ) + (cache (opam-archives (target C:\Users\opam\AppData\Local\opam\download-cache))) + (shell "opam install tar")) ) ``` diff --git a/lib/s.ml b/lib/s.ml index 59d8b3ae..345c5faf 100644 --- a/lib/s.ml +++ b/lib/s.ml @@ -142,7 +142,7 @@ module type BUILDER = sig (** [df t] returns the percentage of free space in the store. *) val shell : t -> string list - (** [shell] optional value to be used as the default shell. *) + (** [shell t] returns the default shell. *) val cache_stats : t -> int * int (** [cache_stats t] returns the number of cache hits and the number of cache misses. *)