docs: document missing LIMA_CIDATA_* env vars#4988
Open
c-tonneslan wants to merge 1 commit into
Open
Conversation
Several variables defined in pkg/cidata/cidata.TEMPLATE.d/lima.env weren't listed in the internals doc. Pulled them in alongside the existing entries, grouped near related variables (disks next to mounts, rosetta near slirp, etc). Closes lima-vm#2791. Also adds entries that were added to the template after the issue was filed (UPGRADE_PACKAGES, YQ_PROVISION_*, NO_CLOUD_INIT) since the issue's ask was really "keep docs in sync with the env file." Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
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
2 participants
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.
Closes #2791.
Several `LIMA_CIDATA_*` variables set in `pkg/cidata/cidata.TEMPLATE.d/lima.env` weren't listed in `website/content/en/docs/dev/internals.md`. Added them alongside the existing entries (disks near mounts, rosetta near slirp, etc).
I also added a handful of variables that the issue didn't list because they were introduced after #2791 was filed (`UPGRADE_PACKAGES`, `YQ_PROVISION_*`, `NO_CLOUD_INIT`). The spirit of the issue is "keep this list in sync with the env file," so it seemed worth pulling them in too. Happy to drop them if you'd prefer a tighter scope.
Test plan
Docs-only change.
```
go build ./...
```
builds, but no behavior changed.