Package pplumbing.0.0.13

[mbarbin]

pplumbing.0.0.13

Utility libraries to use with pp
[pplumbing] defines a set of utility libraries to use with pp. It
is compatible with logs and inspired by design choices used by
dune for user messages:

• [Pp_tty] extends pp to build colored documents in the user's
  terminal using ansi escape codes.

• [Err] is an abstraction to report located errors and warnings to
  the user.

• [Log] is an interface to logs using [Pp_tty] rather than [Format].

• [Log_cli] contains functions to work with [Err] on the side of end
  programs (such as a command line tool). It defines command line
  helpers to configure the [Err] library, while taking care of setting
  the logs and fmt style rendering.

• [Cmdlang_cmdliner_runner] is a library for running command line
  programs specified with cmdlang with cmdliner as a backend and
  making opinionated choices, assuming your dependencies are using
  [Err].

These libraries are meant to combine nicely into a small ecosystem of
useful helpers to build CLIs in OCaml.

---

• Homepage: https://github.com/mbarbin/pplumbing
• Source repo: git+https://github.com/mbarbin/pplumbing.git
• Bug tracker: https://github.com/mbarbin/pplumbing/issues

---

🐫 Pull-request generated by opam-publish v2.5.1

[Zeta611]

Thanks for the contribution @mbarbin! The CI failures seem to be for flambda variants (again), and other than that, it looks good to me. Can you confirm @shonfeder?

[mbarbin]

Thanks @Zeta611 - In case this helps : I have no time pressure to release, if we prefer to think a bit more about these CI failures and whether to try some amends on the package side, it is fine with me. Thank you.

[shonfeder]

Looking the CI results more carefully, I think the reason we are seeing a CI failure in your packagss on flambda (and not in any other packages I've seen), is because of how you are configuring the warning behavior in your builds?

The error is

[ERROR] The compilation of pplumbing.0.0.13 failed at "dune build -p pplumbing -j 71 @install".

#=== ERROR while compiling pplumbing.0.0.13 ===================================#
# context              2.3.0 | linux/x86_64 | ocaml-options-only-flambda.1 | pinned(https://github.com/mbarbin/pplumbing/releases/download/0.0.13/pplumbing-0.0.13.tbz)
# path                 ~/.opam/4.14/.opam-switch/build/pplumbing.0.0.13
# command              ~/.opam/opam-init/hooks/sandbox.sh build dune build -p pplumbing -j 71 @install
# exit-code            1
# env-file             ~/.opam/log/pplumbing-7-e8d3ae.env
# output-file          ~/.opam/log/pplumbing-7-e8d3ae.out
### output ###
# (cd _build/default && /home/opam/.opam/4.14/bin/ocamlopt.opt -w -40 -w +a-4-40-41-42-44-45-48-66 -warn-error +a -g -I lib/log/src/.log.objs/byte -I lib/log/src/.log.objs/native -I /home/opam/.opam/4.14/lib/logs -I /home/opam/.opam/4.14/lib/pp -I lib/pp_tty/src/.pp_tty.objs/byte -I lib/pp_tty/src/.pp_tty.objs/native -intf-suffix .ml -no-alias-deps -o lib/log/src/.log.objs/native/log.cmx -c -impl lib/log/src/log.ml)
# File "_none_", line 1:
# Error (warning 58 [no-cmx-file]): no cmx file was found in path for module Stdune__User_message, and its interface was not compiled with -opaque

And we see that this is actually just a warning. From Drup has noted that

This is a warning, not an error, and you can safely ignore it.

It is here to tell you that the compiler might miss optimizations (since it needs .cmx to do inlining) ... but you really don't care about optimizations for the ocamlbuild plugin, so it's fine.

But you have configured -warn-error +a, which makes all warnings as fatal errors.

IIUC

• to prevent the warnings from occurring, you can submit issues or patches to the offending libraries, as Drup recommends, to ensure they are incuding .cmx files.
• to allow more flexible installation, I would advise not making all warnings errors in your builds. This is useful in development, but IMO probably not the behavior we'd want in releases? Given that, afaiu, dune already treats warnings as errors in dev mode do you actually need to be setting that flag?

I am OK with merging this as is, but would you like to try fixing the build rules so people could install this using flambda in ocaml 4.14 (and perhaps in other context where warnings might occur)?

[mbarbin]

• to allow more flexible installation, I would advise not making all warnings errors in your builds. This is useful in development, but IMO probably not the behavior we'd want in releases? Given that, afaiu, dune already treats warnings as errors in dev mode do you actually need to be setting that flag?

Thanks a lot, this is really helpful. My attention wasn't on the warnings, and this is new information for me. I'll take some time to reflect on this. This particular setup is pretty pervasive on my side, but it doesn't mean I can't adjust. Let's hold on for, as I consider some amends on my side, experiment some more with dev mode. etc. Thanks!