doc: explanation of how libraries depend on one another #3469
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3469 +/- ##
==========================================
- Coverage 77.35% 77.35% -0.01%
==========================================
Files 1076 1076
Lines 68922 68922
==========================================
- Hits 53317 53315 -2
- Misses 15605 15607 +2 ☔ View full report in Codecov by Sentry. |
mattkae
force-pushed
the
docs/libraries_explanation
branch
from
2f18e0d to
e098fd0
Compare
mattkae
force-pushed
the
docs/libraries_explanation
branch
from
e098fd0 to
71a9348
Compare
doc/sphinx/explanation/libraries.md
Outdated
Comment on lines
54
to
55
| Mir builds a number of static libraries that are linked to internally by | ||
| `mirserver`. These libraries are: |
There was a problem hiding this comment.
Your list includes some of the "object" libraries. I think there's only one static library linked by mirserver (kms_utils).
AlanGriffiths
requested changes
Jul 11, 2024
doc/sphinx/explanation/libraries.md
Outdated
Comment on lines
45
to
46
| - `miral` and `miroil` are intended to be the primary user-facing libraries as | ||
| nothing else depends on them |
There was a problem hiding this comment.
It is miral and mircore that are intended to be the primary user-facing libraries.
Miroil needs special mention as a "compatibility layer" for Lomiri that is not intended for general consumption
AlanGriffiths
requested changes
Jul 11, 2024
RAOF
approved these changes
Jul 12, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check out https://canonical-mir--3469.com.readthedocs.build/3469/explanation/libraries/