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

Fix (some) odoc warnings #53

Merged
merged 4 commits into from
Jan 7, 2025
Merged

Fix (some) odoc warnings #53

merged 4 commits into from
Jan 7, 2025

Conversation

mbarbin
Copy link
Contributor

@mbarbin mbarbin commented Jan 5, 2025

I noticed a number of warnings when building the doc target locally and thought I would attempt to look into it.

As it turns out, most warnings of the unresolvedroot kind look like bugs. For example:

File "lib/miou.mli", line 899, characters 4-57:
Warning: Failed to resolve reference unresolvedroot(Invalid_argument) Couldn't find "Invalid_argument"

Instead of pursuing those, I switched to compiling the doc-new target instead, which I presume, by bringing external dependencies into the scope, resolves these kinds of warnings. I then focused on fixing the remaining warnings only.

There remain 2 at the tip of the PR, but I believe they come from external dependencies, so there's no point in trying to solve them here.

$ dune build @doc-new
File "src/fmt_cli.mli", line 6, characters 4-15:
Warning: Failed to resolve reference unresolvedroot(Cmdliner) Couldn't find "Cmdliner"
File "src/fmt.mli", line 6, characters 4-13:
Warning: Failed to resolve reference unresolvedroot(Format) Couldn't find "Format"

@dinosaure
Copy link
Contributor

I rebased your PR. Seems ok me, let's see the CI and I will waiting to see this PR as ready 👍.

mbarbin
mbarbin commented Jan 7, 2025
View reviewed changes
@mbarbin mbarbin marked this pull request as ready for review January 7, 2025 19:25
@mbarbin
Copy link
Contributor Author

mbarbin commented Jan 7, 2025

I enabled for review, modulo just 2 simple remarks, which I just added a review comment. If you are happy with it, I am too. Thanks for looking into the PR!

@dinosaure
Copy link
Contributor

Ok the PR is ready merge, let's go 👍.

@dinosaure dinosaure merged commit c997056 into robur-coop:main Jan 7, 2025
1 check passed
@mbarbin mbarbin deleted the fix-odoc-warnings branch January 7, 2025 19:53
dinosaure added a commit to dinosaure/opam-repository that referenced this pull request Jan 13, 2025
@dinosaure
[new release] miou (0.3.1)
a58e9bb 
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)
@dinosaure dinosaure mentioned this pull request Jan 13, 2025
Merged
davesnx pushed a commit to davesnx/opam-repository that referenced this pull request Mar 12, 2025
@dinosaure
[new release] miou (0.2.0)
85b3a7a 
CHANGES:

- Don't try to abusively fill the pipe to interrupt a domain

  Interrupting a domain involves writing to a pipe to interrupt the `select(2)`
  if it is running. The pipe has a limited memory, depending on the system, and
  if you ask to interrupt a domain too much, you end up blocking the `write`.
  This patch prevents writing to the pipe if it has not yet been read.

  (@dinosaure, robur-coop/miou#46)

- Expose the Sequence module
  (@dinosaure, robur-coop/miou#47)
- Be able to add a hook (effect free) into the scheduler

  It is possible to add a hook to the scheduler. If the user wants to execute a
  function to a domain each time the domain is busy with a task, they can do so.
  However, the effects are not managed in the passed function.

  (@dinosaure, robur-coop/miou#48)

- Add `Miou.Lazy`, a domain-safe `Lazy` module like `Stdlib.Lazy`
  (@dinosaure, initially implemented by @polytypic, robur-coop/miou#49)
- Raise an exception if the user uses syscalls (from `Miou_unix`) and `Miou.run`
  instead of `Miou_unix.run`

  If a user uses a suspend function offered by `Miou_unix` but does not use
  `Miou_unix.run`, the programme may block indefinitely. This patch prevents
  such an error by raising an exception if we want to add a suspension point and
  we haven't specified how to handle it (if we use `Miou.run` instead of
  `Miou_unix.run`).

  (@dinosaure, reported by @kit-ty-kate, robur-coop/miou#51)

- Rename `Miou.set_signal` to `Miou.sys_signal`
  (@dinosaure, robur-coop/miou#50)

- Improve `Miou_unix.{read,write}`
  (@kit-ty-kate, @dinosaure, robur-coop/miou#52, 2f552a6, robur-coop/miou#54)
- Fix an issue related to the dom0 and pending tasks locked by mutexes

  Tasks may have been transmitted to dom0 while it was executing a task and
  before the `select(2)`. This patch resynchronises the pending tasks in dom0's
  TODO-list before making the `select(2)`: specifically to find out whether the
  `select(2)` can block indefinitely or not. This patch also cleans up the old
  states of the tables used by `Miou_unix` if it is used on an ongoing basis (as
  in the case of tests).

  (@dinosaure, robur-coop/miou#53)

- Add `Miou.Domain.available`
  (@dinosaure, robur-coop/miou#53)
- Fix a race condition (observed with TSan) when we wait the cancellation of a
  children

  This patch changes Miou's behaviour a little when waiting for a task to be
  cancelled and prevents invalid access to a value that does not belong to the
  current domain (and which can be modified by another domain). Thanks
  @OlivierNicole and @fabbing for their advice on using TSan.

  (@dinosaure, robur-coop/miou#56)

- Update the layout of Miou to avoid conflicts with other packages (like `backoff`)
  (@dinosaure, reported by @patricoferris, robur-coop/miou#57)
- OCaml 5.3 support
  (@kit-ty-kate, github#22)
- Rename `Miou.call_cc` to `Miou.async`
  (@dinosaure, @kit-ty-kate, @Armael, github#23)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dinosaure dinosaure dinosaure left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mbarbin @dinosaure