Consolidate mirage bootvar #1533
Conversation
hannesm
force-pushed
the
consolidate-mirage-bootvar
branch
from
cc63ae0
to
07b65c3
Compare
|
To go a bit deeper on my motivation: I find this makes it much easier for developers to discover the code MirageOS uses. It can easily be compared what the difference between the different targets is, and API changes can be done very locally without having to think about the "release train" and in which order to release what. Furthermore, the complexity on tooling (let's say opam) is reduced by the reduction of opam packages that are required in the universe. Also, the maintenance of mirage is relaxed - we can replace (archive) 4 git repositories with all sorts of (partially outdated) metadata by a single one. I guess a question is whether we should "buy in" into dune variants -- and my point of view is that it radically simplifies our tooling, plus enhances the developer experience (not shown here, since there isn't any functor removed) -- and one of the (at least for me) most useful feature of IDEs (or editor support), the "jump to definition", is finally on the horizon to work just neatly. |
|
Thank you, this PR looks good to me! |
|
This change seems very uncontroversial and so looks great to me - could you please update the test outputs to please the CI? |
|
This needs to wait for ocaml/opam-repository#25887 being merged to have the CI pass. |
hannesm
force-pushed
the
consolidate-mirage-bootvar
branch
from
07b65c3
to
f2067d3
Compare
|
|
hannesm
force-pushed
the
consolidate-mirage-bootvar
branch
from
69ef9e7
to
541ee38
Compare
|
I moved forth and back... so our Reality shows there are some packages that don't provide |
this reduces the dependency cone and complexity for figuring out how the argument vector is retrieved and parsed by MirageOS unikernels
hannesm
force-pushed
the
consolidate-mirage-bootvar
branch
from
541ee38
to
2026b03
Compare
CHANGES: - BREAKING: remove `~name` parameter from Mirage.Runtime_args.create (mirage/mirage#1541 @samoht, fixes mirage/mirage#1532) - BREAKING: remove `~name` parameter from Mirage.runtime_arg, and use a string (instead of a format string) as third parameter (mirage/mirage#1541 @samoht) - constrain the `start` function to `unit Lwt.t`. Previously, there was no restrictions, and lots of time was spent in debugging when a unikernel resulted in `unit Lwt.t Lwt.t` (@Julow mirage/mirage#1524) - revise man page sections and ordering: ARGUMENTS, OPTIONAL, NETWORK OPTIONS, DISK OPTIONS, LOG AND MONITORING OPTIONS, OCAML RUNTIME OPTIONS. Previously, the ARGUMENTS and OPTIONS were put later, and were hard to find. These are the sections where unikernel-specific arguments are put by default (mirage/mirage#1531 @hannesm @reynir) - add --net=host and --net=ocaml to reduce confusion. --net=host uses the TCP/IP socket stack, --net=ocaml the OCaml network stack (mirage/mirage#1525 @hannesm) - quote Runtime_arg.call (mirage/mirage#1522 @Julow) - documentation fixes (inline examples @Julow mirage/mirage#1523, @hannesm mirage/mirage#1537 (fixes mirage/mirage#1512 reported by @reynir), Runtime_args.create mirage/mirage#1541 @samoht) - fix the build instructions of the generated opam file: since 4.5.0 `mirage build` is no longer available, use `make "build"` (mirage/mirage#1527 @hannesm) - add RELEASE.md, a guide on how to cut a mirage release (mirage/mirage#1519 @samoht) - allow git 3.16 (mirage/mirage#1536 @hannesm) - use mirage-bootvar (using dune variant) instead of parse-argv and mirage-bootvar-xen, mirage-bootvar-solo5, mirage-bootvar-unix (mirage/mirage#1533 @hannesm) - BUGFIX: reset the lexer location before applying functors in generated code (mirage/mirage#1539 @samoht, fixes mirage/mirage#1520 @hannesm) - BUGFIX: fix off-by-one locations for mirage/main.ml (mirage/mirage#1540 @samoht, fixes mirage/mirage#1528 @hannesm)
I found an even simpler example than "mirage-time" in respect to "how to use dune variants": boot parameters.
We used to have mirage-bootvar-xen, mirage-bootvar-unix, mirage-bootvar-solo5, and the parse-argv opam packages that were all involved.
Now, I created (retaining history) the single repository https://github.com/mirage/mirage-bootvar. This uses dune variants, the default is the unix implementation.
What is interesting about bootvar is that no one bothered to functorize it ;) Also, it shows how a unikernel could still decide to use "no_argv", bypassing any dune variant restrictions (I'm not sure whether this is desirable, but it is possible -- this also sheds some light that we could use configure-time keys to select some other implementation).
Anyways, this is much simpler than #1529 and you may enjoy looking into it.
EDIT: CI fails since the mirage-bootvar is not released, I'm happy to do that if no one objects about the approach taken.