docs: MIR: describe dependencies of some binary packages

Open Beginner friendly
#784 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
73/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
documentation

Research direction

Open the MIR main inclusion review page and find the paragraph about main components, then compare it with the linked Launchpad case involving uwsgi binary packages and universe dependencies. Update the documentation to distinguish source packages from the affected binary packages and clarify when dependencies require promotion; done when the exception is documented without weakening the general rule.

Written by the indexing model from the issue text.

Description

MIR untriaged

In https://bugs.launchpad.net/ubuntu/+source/uwsgi/+bug/2151202 we saw several dependencies in universe that were pulled in during the build, and will affect the binary artifacts, but they didn't need to be promoted to main because they only influenced certain binary packages created from the source package -- and we're not promoting all the binary packages to main, only a subset.

It'd be nice to describe this case on the documentation, near this paragraph:

For something to be allowed into main, all its code and runtime dependencies must be in main. The MIR team checks for missing dependencies via component-mismatches reports, discussed as part of the MIR team meeting.

I think it's worth writing down, since we've had some last-minute surprises of universe dependencies that needed an immediate MIR, because the universe deps were missed through the process; and yet, sometimes we have cases like this where it's not a hard rule that dependencies need to be in main. That paragraph doesn't draw distinctions between source and binary packages .. and I'm not entirely sure if the components-mismatch tool is working strictly on binary packages but displaying source packages or if it's working on source packages. (I think it has to be binary packages, otherwise it'd be unusable, right?)

Thanks

Reported from: https://ubuntu.com/project/docs/MIR/main-inclusion-review/

Dominant language
Python
Stars
34
Forks
119
Avg merge
2d 17h
Merged PRs (30d)
21

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ubuntu/ubuntu-project-docs

All issues in ubuntu/ubuntu-project-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.