port to dune and port opam metadata to 2.0

* Port library to Dune from jbuilder and the builtin
  `dune.configurator` to reduce the build dependency cone
* Remove unused variable warnings (@avsm).
* Update opam package metadata to 2.0 format (@avsm).

CHANGES.md

@@ -1,3 +1,17 @@
+### v2.0.0
+
+* Constrain the clock type `t` to `unit` to improve compatability with
+  the webmachine CLOCK interface. All current implementations satisfy
+  this interface so there shouldn't be an issue, but bumping the
+  library major version number to reflect the interface change (#38 @hannesm)
+
+* Port library to Dune from jbuilder and use `dune-release` and the builtin
+  `dune.configurator` to reduce the build dependency cone (@avsm).
+
+* Remove unused variable warnings (@avsm).
+
+* Update opam package metadata to 2.0 format (@avsm).
+
 ### v1.4.1 (2018-08-03)
 
 * mirage-clock-unix: fix integer overflow on 32 bit (#37, @mattgray)

Makefile

@@ -1,30 +1,19 @@
-
 .PHONY: build clean test
 
 build:
-	jbuilder build @install
+	dune build @install
 
 test:
-	jbuilder runtest
+	dune runtest
 
 install:
-	jbuilder install
+	dune install
 
 uninstall:
-	jbuilder uninstall
-
-clean:
-	rm -rf _build *.install
+	dune uninstall
 
-REPO=../../mirage/opam-repository
-PACKAGES=$(REPO)/packages
-# until we have https://github.com/ocaml/opam-publish/issues/38
-pkg-%:
-	topkg opam pkg -n $*
-	mkdir -p $(PACKAGES)/$*
-	cp -r _build/$*.* $(PACKAGES)/$*/
-	cd $(PACKAGES) && git add $*
+doc:
+	dune build @doc
 
-PKGS=$(basename $(wildcard *.opam))
-opam-pkg:
-	$(MAKE) $(PKGS:%=pkg-%)
+clean:
+	dune clean

config/discover.ml

@@ -1,16 +1,10 @@
-open Base
-open Stdio
-module C = Configurator
-
-let write_sexp fn sexp =
-  Out_channel.write_all fn ~data:(Sexp.to_string sexp)
+module C = Configurator.V1
 
 let () =
   C.main ~name:"mirage-clock-unix" (fun c ->
     let ccflags =
       match C.ocaml_config_var c "system" with
       | Some "linux" -> ["-lrt"]
       | _ -> [] in
-    write_sexp "cclib.sexp" (Sexp.List (List.map ~f:(fun x -> Sexp.Atom x) ccflags));
-    Out_channel.write_all "cclib" ~data:(String.concat ccflags  ~sep:" ")
+    C.Flags.write_sexp "cclib.sexp" ccflags;
   )

config/dune

@@ -0,0 +1,8 @@
+(executables
+ (names discover)
+ (libraries dune.configurator))
+
+(rule
+ (targets cclib.sexp)
+ (deps    discover.exe)
+ (action  (run ./discover.exe)))

dune-project

@@ -0,0 +1,2 @@
+(lang dune 1.0)
+(name mirage-clock)

freestanding/dune

@@ -0,0 +1,5 @@
+(library
+ (name        mirage_clock_freestanding)
+ (wrapped     false)
+ (public_name mirage-clock-freestanding)
+ (libraries   mirage-clock mirage-clock-lwt))

freestanding/mclock.ml

@@ -16,7 +16,6 @@
 
 type t = unit
 type 'a io = 'a Lwt.t
-type error = unit
 
 let connect _ = Lwt.return_unit
 let disconnect _t = Lwt.return_unit

freestanding/pclock.ml

@@ -16,7 +16,6 @@
 
 type t = unit
 type 'a io = 'a Lwt.t
-type error = unit
 
 external time : unit -> float = "unix_gettimeofday"
 
@@ -28,7 +27,7 @@ let connect _ = Lwt.return_unit
 let disconnect _t = Lwt.return_unit
 
 (* Based on Ptime.of_float_s *)
-let now_d_ps t =
+let now_d_ps () =
   let secs = time () in
   if secs <> secs then failwith "unix_gettimeofday returned NaN" else
   let days = floor (secs /. 86_400.) in
@@ -42,10 +41,10 @@ let now_d_ps t =
   let frac_ps = Int64.(of_float (frac_s *. 1e12)) in
   (int_of_float days, (Int64.add rem_ps frac_ps))
 
-let current_tz_offset_s t = None
+let current_tz_offset_s () = None
 
 (* According to
  * https://github.com/mirage/mini-os/blob/edfd5aae6ec5ba7d0a8834a3e9dfe5e69424150a/arch/x86/time.c#L194
  * the clock period is 1 microsecond
  * *)
-let period_d_ps t = Some (0, 1_000_000L)
+let period_d_ps () = Some (0, 1_000_000L)

lib_test/dune

@@ -0,0 +1,3 @@
+(test
+ (name portable)
+ (libraries lwt.unix mirage-clock-unix))

lib_test/portable.ml

@@ -9,7 +9,7 @@ let print_offset c = match Pclock.current_tz_offset_s c with
   | None -> Printf.printf "Clock UTC offset unavailable\n"
 
 let print_period c = match Pclock.period_d_ps c with
-  | Some (d, ps) -> Printf.printf "The clock period is: %Ld picoseconds\n" ps
+  | Some (_, ps) -> Printf.printf "The clock period is: %Ld picoseconds\n" ps
   | None -> Printf.printf "Clock period unavailable\n"
 
 let print_mtime c =

lwt/dune

@@ -0,0 +1,4 @@
+(library
+ (name        mirage_clock_lwt)
+ (public_name mirage-clock-lwt)
+ (libraries   mirage-clock lwt))

mirage-clock-freestanding.opam

@@ -1,19 +1,27 @@
-opam-version: "1.2"
-authors: ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
+opam-version: "2.0"
 maintainer: "anil@recoil.org"
+authors: ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
+license: "ISC"
+tags: "org:mirage"
 homepage: "https://github.com/mirage/mirage-clock"
 bug-reports: "https://github.com/mirage/mirage-clock/issues"
-dev-repo: "git://github.com/mirage/mirage-clock"
-license: "ISC"
-tags: ["org:mirage"]
+synopsis: "Paravirtual implementation of the MirageOS Clock interface"
+description: """
+This 'freestanding' implementation of the MirageOS CLOCK interface
+is designed to be linked against an embedded runtime that provides
+a concrete implementation of the clock source. Example implementations
+include the [Solo5](https://github.com/solo5/solo5) backend of
+MirageOS.
+"""
 depends: [
-  "jbuilder" {build & >="1.0+beta9"}
-  "mirage-clock" {>= "1.2.0"}
-  "mirage-clock-lwt" {>= "1.2.0"}
+  "ocaml" {>= "4.04.2"}
+  "dune" {build}
+  "mirage-clock" {>= version}
+  "mirage-clock-lwt" {>= version}
   "lwt"
 ]
 build: [
-  [ "jbuilder" "subst" ] {pinned}
-  [ "jbuilder" "build" "-p" name "-j" jobs ]
+  ["dune" "subst"] {pinned}
+  ["dune" "build" "-p" name "-j" jobs]
 ]
-available: [ ocaml-version >= "4.04.2" ]
+dev-repo: "git://github.com/mirage/mirage-clock"

mirage-clock-lwt.opam

@@ -1,20 +1,24 @@
-opam-version: "1.2"
-authors:      ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
-maintainer:   "anil@recoil.org"
-homepage:     "https://github.com/mirage/mirage-clock"
-bug-reports:  "https://github.com/mirage/mirage-clock/issues"
-dev-repo:     "https://github.com/mirage/mirage-clock.git"
-doc:          "https://mirage.github.io/mirage-clock/"
-license:      "ISC"
-tags:         ["org:mirage"]
-
+opam-version: "2.0"
+maintainer: "anil@recoil.org"
+authors: ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
+license: "ISC"
+tags: "org:mirage"
+homepage: "https://github.com/mirage/mirage-clock"
+doc: "https://mirage.github.io/mirage-clock/"
+bug-reports: "https://github.com/mirage/mirage-clock/issues"
+synopsis: "Lwt-based implementation of the MirageOS Clock interface"
+description: """
+This implementation of the MirageOS CLOCK interface specialises
+the `io` type to use the Lwt concurrency monad.
+"""
 depends: [
-  "jbuilder"   {build & >="1.0+beta9"}
-  "mirage-clock" {>= "1.2.0"}
+  "ocaml" {>= "4.04.2"}
+  "dune" {build}
+  "mirage-clock" {>= version}
   "lwt"
 ]
 build: [
-  [ "jbuilder" "subst" ] {pinned}
-  [ "jbuilder" "build" "-p" name "-j" jobs ]
+  ["dune" "subst"] {pinned}
+  ["dune" "build" "-p" name "-j" jobs]
 ]
-available: [ ocaml-version >= "4.04.2" ]
+dev-repo: "git+https://github.com/mirage/mirage-clock.git"

mirage-clock-unix.opam

@@ -1,23 +1,27 @@
-opam-version: "1.2"
-authors:      ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
-maintainer:   "anil@recoil.org"
-homepage:     "https://github.com/mirage/mirage-clock"
-bug-reports:  "https://github.com/mirage/mirage-clock/issues"
-dev-repo:     "https://github.com/mirage/mirage-clock.git"
-doc:          "https://mirage.github.io/mirage-clock/"
-license:      "ISC"
-tags:         ["org:mirage"]
-
+opam-version: "2.0"
+maintainer: "anil@recoil.org"
+authors: ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
+license: "ISC"
+tags: "org:mirage"
+homepage: "https://github.com/mirage/mirage-clock"
+doc: "https://mirage.github.io/mirage-clock/"
+bug-reports: "https://github.com/mirage/mirage-clock/issues"
+synopsis: "Unix-based implementation for the MirageOS Clock interface"
+description: """
+The Unix implementation of the MirageOS Clock interface uses
+`gettimeofday` or `clock_gettime`, depending on
+which OS is in use (see [clock_stubs.c](https://github.com/mirage/mirage-clock/blob/master/unix/clock_stubs.c)).
+"""
 depends: [
-  "jbuilder" {build & >="1.0+beta9"}
-  "mirage-clock" {>= "1.2.0"}
-  "mirage-clock-lwt" {>= "1.2.0"}
+  "ocaml" {>= "4.04.2"}
+  "dune" {build}
+  "mirage-clock" {>= version}
+  "mirage-clock-lwt" {>= versionn}
   "lwt"
-  "configurator" {build}
 ]
 build: [
-  [ "jbuilder" "subst" ] {pinned}
-  [ "jbuilder" "build" "-p" name "-j" jobs ]
+  ["dune" "subst"] {pinned}
+  ["dune" "build" "-p" name "-j" jobs]
+  ["dune" "runtest" "-p" name] {with-test}
 ]
-build-test: ["jbuilder" "runtest" "-p" name]
-available: [ ocaml-version >= "4.04.2" ]
+dev-repo: "git+https://github.com/mirage/mirage-clock.git"

mirage-clock.opam

@@ -1,19 +1,28 @@
-opam-version: "1.2"
-authors:      ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
-maintainer:   "anil@recoil.org"
-homepage:     "https://github.com/mirage/mirage-clock"
-bug-reports:  "https://github.com/mirage/mirage-clock/issues"
-dev-repo:     "https://github.com/mirage/mirage-clock.git"
-doc:          "https://mirage.github.io/mirage-clock/"
-license:      "ISC"
-tags:         ["org:mirage"]
+opam-version: "2.0"
+maintainer: "anil@recoil.org"
+authors: ["Anil Madhavapeddy" "Daniel C. Bünzli" "Matthew Gray"]
+license: "ISC"
+tags: "org:mirage"
+homepage: "https://github.com/mirage/mirage-clock"
+doc: "https://mirage.github.io/mirage-clock/"
+bug-reports: "https://github.com/mirage/mirage-clock/issues"
+synopsis: "Libraries and module types for portable clocks"
+description: """
+This library implements portable support for an operating system timesource
+that is compatible with the [MirageOS](https://mirage.io) library interfaces
+found in: <https://github.com/mirage/mirage>
 
+It implements an `MCLOCK` module that represents a monotonic timesource
+since an arbitrary point, and `PCLOCK` which counts time since the Unix
+epoch.
+"""
 depends: [
-  "jbuilder" {build & >="1.0+beta9"}
+  "ocaml" {>= "4.04.2"}
+  "dune" {build}
   "mirage-device" {>= "1.0.0"}
 ]
 build: [
-  [ "jbuilder" "subst" ] {pinned}
-  [ "jbuilder" "build" "-p" name "-j" jobs ]
+  ["dune" "subst"] {pinned}
+  ["dune" "build" "-p" name "-j" jobs]
 ]
-available: [ ocaml-version >= "4.04.2" ]
+dev-repo: "git+https://github.com/mirage/mirage-clock.git"

src/dune

@@ -0,0 +1,4 @@
+(library
+ (name        mirage_clock)
+ (public_name mirage-clock)
+ (libraries   mirage-device))

unix/dune

@@ -0,0 +1,8 @@
+(library
+ (name        mirage_clock_unix)
+ (wrapped     false)
+ (public_name mirage-clock-unix)
+ (libraries   mirage-clock mirage-clock-lwt)
+ (c_names     clock_stubs)
+ (c_flags ((:standard \ -Wall -g -O2)))
+ (c_library_flags (:standard (:include ../config/cclib.sexp))))

unix/mclock.ml

@@ -15,7 +15,7 @@
  *)
 type t = unit
 type 'a io = 'a Lwt.t
-type error = unit
+type _error = unit
 
 external _elapsed_ns : unit -> int64 = "ocaml_monotonic_clock_elapsed_ns"