Port to Dune + CI

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        ocaml-version:
+          - 4.09.1
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set-up OCaml ${{ matrix.ocaml-version }}
+        uses: avsm/setup-ocaml@v1
+        with:
+          ocaml-version: ${{ matrix.ocaml-version }}
+
+      - run: opam pin add ocamlclean.dev . --no-action
+      - run: opam install . --deps-only
+      - run: opam exec -- make

.gitignore

@@ -1,4 +1 @@
-src/_build/
-src/config.ml
-etc/Makefile.conf
-etc/config.ml
+_build/

INSTALL

@@ -1,49 +1,22 @@
-                   Installing OCamlClean on a Unix machine
-                   ---------------------------------------
+                   Installing OCamlClean on a machine
+                   ----------------------------------
 
 PREREQUISITES
 
 * The OCaml standard distribution
+* Dune
 
 
 INSTALLATION INSTRUCTIONS
 
-1- Configure the system. From the top directory, do:
-
-        ./configure
-
-This generates the two configuration files "Makefile.conf" and "config.ml"
-in the ./etc/ subdirectory.
-
-The "configure" script accepts the following options:
-
--bindir <dir>                   (default: /usr/local/bin)
-        Directory where the binaries will be installed.
-
--mandir <dir>                   (default: /usr/local/man/man1)
-        Directory where the manual pages will be installed.
-
--prefix <dir>                   (default: /usr/local)
-        Set bindir and mandir to <dir>/bin, <dir>/man/man1 respectively.
-
-
-Examples:
-
-  Standard installation in /usr/{bin,man} instead of /usr/local:
-    ./configure -prefix /usr
-
-  Installation in /usr, man pages in section "l":
-    ./configure -bindir /usr/bin -mandir /usr/man/manl
-
-
-2- From the top directory, do:
+1- From the top directory, do:
 
         make
 
-This builds the ocamlclean program in directory: ./bin/.
+This builds the ocamlclean program in directory: _build/install/default/bin/
 
 
-3- You can now install the OCamlClean system. This will create the
+2- You can now install the OCamlClean system. This will create the
 following command (in the binary directory selected during
 autoconfiguration):
 
@@ -52,20 +25,16 @@ autoconfiguration):
 From the top directory, become superuser and do:
 
         umask 022       # make sure to give read & execute permission to all
-        make install
+        dune install
 
-4- Installation is complete. Time to clean up. From the toplevel
+3- Installation is complete. Time to clean up. From the toplevel
 directory, do:
 
         make clean
 
 
 UNINSTALLATION INSTRUCTIONS
 
-1- If configuration files (./etc/Makefile.conf and ./etc/config.ml)
-have been lost, run again ./configure from the top directory with the
-same options as at step 1 of installation.
-
-2- From the top directory, become superuser and do:
+1- From the top directory, become superuser and do:
 
         make uninstall

Makefile

@@ -9,38 +9,21 @@
 ##                                                                       ##
 ###########################################################################
 
-include etc/Makefile.conf
+DUNE=dune
 
-all: config
-	$(call compile, src)
-
-config:
-	@if [ $(ETC)/Makefile.conf -ot VERSION -o \
-             $(ETC)/Makefile.conf -ot configure ]; then \
-          echo 'Configuration files are not up to date.' 1>&2; \
-	  echo 'Please run `./configure` (with right options).' 1>&2; \
-          exit 1; \
-	fi
+all:
+	$(DUNE) build @install
 
 install: all
-	mkdir -p "$(BINDIR)"
-	mkdir -p "$(MAN1DIR)"
-	cp bin/ocamlclean "$(BINDIR)/ocamlclean"
-	cp man/ocamlclean.1.gz "$(MAN1DIR)/ocamlclean.1.gz"
+	$(DUNE) install
 
 uninstall:
-	-rm -f "$(BINDIR)/ocamlclean"
-	-rm -f "$(MAN1DIR)/ocamlclean.1.gz"
-
-etc/Makefile.conf:
-	@echo "You must run ./configure before" 1>&2
-	@exit 1
+	$(DUNE) uninstall
 
 dist: clean
 	dist/distgen
 
 clean:
-	@rm -f *~ */*~ */*/*~
-	$(call clean, src)
+	$(DUNE) clean
 
-.PHONY: all config install uninstall dist clean
+.PHONY: all install uninstall dist clean

dist/distgen

@@ -12,15 +12,16 @@
 
 cd $(dirname "$0")
 
-VERSION=$(cat ../VERSION)
+VERSION=$(sed -ne 's/.*(version \+\(.*\) *).*/\1/p' ../dune-project)
 DEST=ocamlclean-"$VERSION"
 
-for d in "$DEST" "$DEST/dist" "$DEST/etc"; do
+for d in "$DEST" "$DEST/dist"; do
     mkdir "$d"
 done
 
 for d in \
-    bin configure INSTALL LICENSE-fr LICENSE-en Makefile man src VERSION;
+    INSTALL LICENSE-fr LICENSE-en Makefile man src \
+    dune-project ocamlclean.opam;
 do
     cp -R ../"$d" "$DEST/"
 done

dune-project

@@ -0,0 +1,3 @@
+(lang dune 1.0)
+(name ocamlclean)
+(version 2.2)

man/dune

@@ -0,0 +1,3 @@
+(install
+  (files ocamlclean.1.gz)
+  (section man))

ocamlclean.opam

@@ -0,0 +1,15 @@
+opam-version: "2.0"
+authors: ["Benoît Vaugon"]
+homepage: "http://www.algo-prog.info/ocapic/web/index.php?id=OCAPIC:OCamlClean"
+bug-reports: "https://github.com/bvaugon/ocamlclean/issues"
+dev-repo: "git+https://github.com/bvaugon/ocamlclean.git"
+maintainer: "[email protected]"
+build: [
+  ["dune" "subst"] {dev}
+  ["dune" "build" "-p" name "-j" jobs "@install"]
+]
+depends: [
+  "ocaml" {>= "4.09" & < "4.10.0"}
+  "dune"
+]
+synopsis: "Reduce size of OCaml bytecode files by dead-code removing"

src/dune

@@ -0,0 +1,7 @@
+(executable
+  (name main)
+  (public_name ocamlclean))
+
+(rule
+  (with-stdout-to config.ml
+    (echo "let version = \"%{version:ocamlclean}\"")))

src/index.ml

@@ -15,7 +15,7 @@ type section = Code | Dlpt | Dlls | Prim | Data | Symb | Crcs | Dbug
 
 type t = (section * int * int) list
 
-let magic_str = "Caml1999X023"
+let magic_str = "Caml1999X026"
 
 let parse ic =
   let magic_size = String.length magic_str in

src/step1.ml

@@ -91,7 +91,7 @@ let prepare_code old_code cleanables ignore_fulls =
                   f (succ indg) adds cleans
               | None -> f (succ indg) adds cleans
           else
-            (List.sort Pervasives.compare adds, cleans)
+            (List.sort Stdlib.compare adds, cleans)
   in
   let adds, cleans = f 0 [] [] in
   let old_code_size = Array.length old_code in