Page MenuHomeVyOS Platform

Extend XML building block overrides to support <help> strings
Closed, ResolvedPublicFEATURE REQUEST

Description

Currently, our XML building block system utilizes the override-default script to keep our XML representations DRY (Don't Repeat Yourself). For repeating configurations (e.g., service ports), we can include a common XML template and dynamically override the <defaultValue>. The script efficiently loads the generated XML and finds the last appropriate XML node describing the defaultValue to use.

While the current implementation works perfectly for <defaultValue>, we still run into situations where an entire XML building block is duplicated solely to change the <help> string displayed on the CLI. Copying a complete XML node just to alter a few words in the help text is superfluous and creates unnecessary maintenance overhead.

Extend the override-default script to support overriding the <help> string found under the <properties> node, using the same logic currently applied to <defaultValue>.

When an XML building block is included, developers should be able to define a new <help> string that overrides the one provided by the base template. The parser should find the last appropriate <help> node and use it in the final generated XML.

Details

Version
-
Is it a breaking change?
Perfectly compatible
Issue type
Internal change (not visible to end users)