Merge pull request #274 from gpetiot/remove-mdx-binary

Do not install deprecated mdx binary anymore

Author: Leonidas-from-XIV

CHANGES.md

@@ -16,6 +16,7 @@
 
 - Dropped compatibility with older OCaml versions. The minimal supported range
   is 4.08 to 4.13 now (#345, @Leonidas-from-XIV)
+- Do not install deprecated `mdx` binary anymore (#274, @gpetiot)
 
 #### Security
 

bin/dune

@@ -9,8 +9,3 @@
  (package mdx)
  (modules :standard \ cli)
  (libraries cli mdx))
-
-(install
- (section bin)
- (files
-  (main.exe as mdx)))

bin/main.ml

@@ -27,14 +27,4 @@ let main =
   ( Term.(ret (const main $ Cli.setup)),
     Term.info "ocaml-mdx" ~version:"%%VERSION%%" ~doc ~exits ~man )
 
-let main () = Term.(exit_status @@ eval_choice main cmds)
-
-let main () =
-  if String.compare Sys.argv.(0) "mdx" == 0 then
-    Format.eprintf
-      "\x1b[0;1mWarning\x1b[0m: 'mdx' is deprecated and will one day be removed.\n\
-      \    Use 'ocaml-mdx' instead\n\
-       %!";
-  main ()
-
-let () = main ()
+let () = Term.(exit_status @@ eval_choice main cmds)

dune-project

@@ -17,7 +17,7 @@
  (name mdx)
  (synopsis "Executable code blocks inside markdown files")
  (description
-   "`ocaml-mdx` allows to execute code blocks inside markdown files.\nThere are (currently) two sub-commands, corresponding\nto two modes of operations: pre-processing (`ocaml-mdx pp`)\nand tests (`ocaml-mdx test`).\n\nThe pre-processor mode allows to mix documentation and code,\nand to practice \"literate programming\" using markdown and OCaml.\n\nThe test mode allows to ensure that shell scripts and OCaml fragments\nin the documentation always stays up-to-date.\n\n`ocaml-mdx` is released as two binaries called `ocaml-mdx` and `mdx` which are\nthe same, mdx being the deprecated name, kept for now for compatibility.")
+   "`ocaml-mdx` allows to execute code blocks inside markdown files.\nThere are (currently) two sub-commands, corresponding\nto two modes of operations: pre-processing (`ocaml-mdx pp`)\nand tests (`ocaml-mdx test`).\n\nThe pre-processor mode allows to mix documentation and code,\nand to practice \"literate programming\" using markdown and OCaml.\n\nThe test mode allows to ensure that shell scripts and OCaml fragments\nin the documentation always stays up-to-date.")
  (depends
   (ocaml
    (>= 4.08.0))

mdx.opam

@@ -11,10 +11,7 @@ The pre-processor mode allows to mix documentation and code,
 and to practice "literate programming" using markdown and OCaml.
 
 The test mode allows to ensure that shell scripts and OCaml fragments
-in the documentation always stays up-to-date.
-
-`ocaml-mdx` is released as two binaries called `ocaml-mdx` and `mdx` which are
-the same, mdx being the deprecated name, kept for now for compatibility."""
+in the documentation always stays up-to-date."""
 maintainer: ["Thomas Gazagnaire <[email protected]>"]
 authors: ["Thomas Gazagnaire <[email protected]>"]
 license: "ISC"

test/bin/mdx-test/misc/no-such-file/dune

@@ -3,7 +3,7 @@
   test.output
   (with-accepted-exit-codes
    (not 0)
-   (run %{bin:mdx} test foo))))
+   (run %{bin:ocaml-mdx} test foo))))
 
 (rule
  (alias runtest)

test/bin/mdx-test/misc/no-such-prelude/dune

@@ -3,7 +3,7 @@
   test.output
   (with-accepted-exit-codes
    (not 0)
-   (run %{bin:mdx} test test.md --prelude "env:foo"))))
+   (run %{bin:ocaml-mdx} test test.md --prelude "env:foo"))))
 
 (rule
  (alias runtest)