Documentation: don't refer to functoria documentation #1512
Comments
|
Yea, that's a very good point. I'm trying to fix those when I see those references, but it would be nice to have a more systematic review of those references. |
|
I addressed the observed issues in #1537, happy to get a review. |
hannesm
added a commit
to hannesm/opam-repository
that referenced
this issue
May 17, 2024
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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
From time to time I look up documentation using either Merlin or ocp-browser, and a few values such as
Mirage.packagesays e.g. "Same as Functoria.Package.v". This is rather annoying as in both Merlin and ocp-indent there are no hyperlinks to get to the actual documentation.Another one is
Mirage.implthat defines itself asof_device @@ Device.vwhereMiragedoesn't even have aDevicemodule.Somewhat motivated by mirage/mirage-skeleton#388.
The text was updated successfully, but these errors were encountered: