lima-vm / lima-vm/lima

Make validation warnings more clear

Open
#3,011 0 comments 0 reactions 0 assignees View on GitHub
area/cli documentation
Dominant language
Go
Stars
21.9k
Forks
957
Avg merge
2d 6h
Merged PRs (30d)
53

Description

It is easy to grep for the warning text and understand why it happens but the warning should make it clear that this is a validation warning, and the issue is unknown property. Maybe something like:

validate vmType vz: ignoring unknown property networks[1]: "Metric"

Notes:
- Unify warning test in wsl2 and vz (vz uses "ignoring" and wsl2 uses "Ignoring")
- This is going to be a big rabbit hole; look at https://github.com/lima-vm/lima/issues/2512 for more thoughts on how it should be refactored
- Maybe wait until @jandubois replaces current FileDeafults with upcoming code from template assembly because that might change things around anyways
- Warning message may not be clear enough - it can help to link to the docs for the invalid thing.

_Originally posted by @nirs in https://github.com/lima-vm/lima/pull/3010#discussion_r1880825054_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.