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.

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

Add a documentation about Unix.file_descr, files, sockets and Miou_unix #43

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

dinosaure
Copy link
Contributor

It's legitimate to want to homogenise Miou_unix with the Unix module, but the former has other objectives than offering all the possible system syscalls. In fact, Miou_unix is more concerned with the use of file_descr that can block (such as sockets) but does not concern file manipulation. This commit adds documentation on this subject so that the user understands the difference between Miou_unix.file_descr and Unix.file_descr and why the latter can be used just as much in the context of Miou as the former.

It's legitimate to want to homogenise Miou_unix with the Unix module, but the
former has other objectives than offering all the possible system syscalls. In
fact, Miou_unix is more concerned with the use of file_descr that can block
(such as sockets) but does not concern file manipulation. This commit adds
documentation on this subject so that the user understands the difference
between Miou_unix.file_descr and Unix.file_descr and why the latter can be used
just as much in the context of Miou as the former.
@dinosaure dinosaure merged commit 98b4ee0 into main Sep 23, 2024
1 check failed
@dinosaure dinosaure deleted the document-miou-unix branch September 23, 2024 11:08
dinosaure added a commit to dinosaure/opam-repository that referenced this pull request Jan 13, 2025
CHANGES:

- Notice the domain if it needs to look into the shared heap if a task is ready
  to be transfered (@dinosaure, robur-coop/miou#41)
- Don't use `Option.value` but `match .. with` to calculate the optional length
  for `Miou_unix.{read,write}` (@kit-ty-kate, robur-coop/miou#44)
- Use `List.iter` instead of `Hashtbl.iter` for internal kept file-descriptors
  of `Miou_unix` (@dinosaure, robur-coop/miou#45)
- Improve the documentation of `Miou_unix` about suspended syscalls (@dinosaure,
  @kit-ty-kate, robur-coop/miou#43)
- Export `reraise` (@dinosaure, robur-coop/miou#46)
- Fix an issue on the `dom0` and observe if some tasks must be transfered to it
  (@dinosaure, robur-coop/miou#48)
- Fix documentation (@mbarbin, robur-coop/miou#47)
- Fix the formatter (@mbarbin, robur-coop/miou#51)
- Upgrade miou to `ocamlformat.0.27.0` (@mbarbin, robur-coop/miou#52)
- Add `x-maintenance-intent` (@hannesm, robur-coop/miou#56)
- Improve the documentation and some `odoc` warnings (@mbarbin, robur-coop/miou#53, robur-coop/miou#54)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants