-
-
Notifications
You must be signed in to change notification settings - Fork 234
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
Add generated documentation for image restrictions #820
Comments
Can I get this assigned? We just to have the gen doc comment above where the parameter is being assigned right? |
Done! |
Thanks! How can I validate that documentation is correct? |
The defaults in the documentation is a hyphen, -. In the gendoc comment, would it be better for the default to be specified as a blank like so "default: " or just not leave out the default field entirely? And to clarify, since there's no validation section for image requirements, I'm putting the gendoc comments above where the requirements are being checked. |
I think we've usually just left out the default value in such cases. And yeah, right above the actual check is fine for keys like those which don't have a validator. |
Closes lxc#820 Signed-off-by: Danny Zheng <dannyzheng@utexas.edu>
Closes #820 Signed-off-by: Danny Zheng <dannyzheng@utexas.edu>
Incus is slowly moving to automatically generated documentation for its configuration keys.
This can be done through the
gendoc:generate
type comments in the code, followed by runningmake update-metadata
and consumption in the documentation through{include} ../config-option.txt
.This issue is for the keys defined in
doc/image-handling.md
to be moved to code ininternal/server/instance/drivers/driver_lxc.go
andinternal/server/instance/drivers/driver_qemu.go
.The text was updated successfully, but these errors were encountered: