docs: more specific comments around optimizations#83
Open
agilgur5 wants to merge 1 commit into
Open
Conversation
- the optimizations are pretty nuanced, so I think it would be helpful to be more specific on these lines - could also link to https://docs.astral.sh/uv/guides/integration/docker/#optimizations which has more detail - the `UV_COMPILE_BYTECODE` comment previously didn't say _why_ it was enabled - explicitly state the trade-off now - the `UV_LINK_MODE` comment previously didn't specify _hard_ linking and was a bit ambiguous about what "mounted volume" it was talking about - symlinks [can](https://superuser.com/q/704822/584649) be used across filesystems -- it's specifically _hard_ links that can't be - explicitly specify "hard linking" and say "below cache mount"
Author
|
@zanieb any chance you or someone else from the team could review this? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The optimizations in the
Dockerfileare pretty nuanced, so I think it would be helpful to be more specific on the comments around theuvenvironment variablesEssentially could detail a bit more from https://docs.astral.sh/uv/guides/integration/docker/#optimizations or link to it in the
Dockerfilecomments themselvesDetails
UV_COMPILE_BYTECODEcomment previously didn't say why it was enabledUV_LINK_MODEcomment previously didn't specify hard linking and was a bit ambiguous with "it's a mounted volume"These are the exact comments I suggested to a colleague who was following this example in code review in suttacentral/suttacentral#3575 (comment) and suttacentral/suttacentral#3575 (comment)