-
Notifications
You must be signed in to change notification settings - Fork 347
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
T6342: extend schema to handle documentation in xml #4292
base: current
Are you sure you want to change the base?
Conversation
👍 |
CI integration ❌ failed! Details
|
@@ -2,19 +2,19 @@ | |||
<grammar xmlns="http://relaxng.org/ns/structure/1.0"> | |||
<!-- | |||
interface_definition.rnc: VyConf reference tree XML grammar | |||
|
|||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please clean the stray whitespaces?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can fix it, but this is the generated output from the interface_definition.rnc file with:
trang interface_definition.rnc interface_definition.rng
how should i deal with it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that we have a docker container and people don't have to install trang on their own machines, I wonder if we should even commit .rng files at all, or just generate them at build time. In any case, I think stray whitespace in autogenerated files is not an issue.
Change summary
This PR adds support for structured documentation in interface definitions by extending the RELAX NG schema. The new
docs
element allows for better organized documentation with the following optional elementsTypes of changes
Related Task(s)
https://vyos.dev/T6342
Related PR(s)
vyos/vyos1x-config#32
How to test / Smoketest result
Checklist: