Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mirage.Runtime_arg.create undocumented #1532

Closed
Tracked by #1536
reynir opened this issue May 9, 2024 · 1 comment · Fixed by #1541 or ocaml/opam-repository#25901
Closed
Tracked by #1536

Mirage.Runtime_arg.create undocumented #1532

reynir opened this issue May 9, 2024 · 1 comment · Fixed by #1541 or ocaml/opam-repository#25901

Comments

@reynir
Copy link
Member

reynir commented May 9, 2024

The function Mirage.Runtime_arg.create (which actually lives in Functoria.Runtime_arg.create) is not documented.

mirage/lib/functoria/runtime_arg.mli

Lines 22 to 27 in dceedf1

val create :
pos:string * int * int * int ->
?name:string ->
?packages:Package.t list ->
string ->
'a arg

In particular it's unclear to me what the ?name argument is used for.
@hannesm hannesm mentioned this issue May 16, 2024
Closed
14 tasks
samoht added a commit to samoht/mirage that referenced this issue May 17, 2024
@samoht
Simplify Runtime_args.create
015764a 
Fix mirage#1532
@samoht samoht mentioned this issue May 17, 2024
Merged
@samoht
Copy link
Member

samoht commented May 17, 2024

This is a leftover from the previous implementation - name was now only used for internal names, so I agree it's a bit confusing to still export it. I've created #1541 to remove it completely.

hannesm added a commit to hannesm/opam-repository that referenced this issue May 17, 2024
@hannesm
[new release] mirage (2 packages) (4.5.1)
217abab 
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)
@hannesm hannesm mentioned this issue May 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@samoht @reynir