Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make validation warnings more clear #3011

Open
nirs opened this issue Dec 11, 2024 · 0 comments
Open

Make validation warnings more clear #3011

nirs opened this issue Dec 11, 2024 · 0 comments
Labels
area/cli limactl CLI user experience documentation Improvements or additions to documentation

Comments

@nirs
Copy link
Member

nirs commented Dec 11, 2024

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 Call limadriver.Validate as part of limayaml.Validate #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 #3010 (comment)

@nirs nirs added documentation Improvements or additions to documentation area/cli limactl CLI user experience labels Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli limactl CLI user experience documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant