Skip to content

Resolve "Support XML tags specifying version changes of config file parameters"

What does this MR do?

  • Add new attributes to dorie.parscraper.Parameter for version changes. These attributes are dictionaries to be filled with version number (string) and description values.

  • Update XML parser to read version change tags. Three new tags are introduced: versionadded, versionchanged, and deprecated. They take the version as tag and an optional description as text:

    <versionchanged version="1.1"> Explanation goes here </versionadded>
  • Add a Python unit test reading a pre-defined XML file and comparing the parser result with the intended result.

  • Fix the YAMLLoader warning during CMake configuration by using the unsafe loader explicitly.

Is there something that needs to be double checked?

No

Can this MR be accepted?

  • Implemented support for version XML tags
    • Added Parameter attributes
    • Updated XML parser
  • Added tests:
    • test_xml_param_parser.py
  • Added documentation on parameter XML files: doc/default_files/README.md
  • Pipeline passing
  • Squash option set
  • Delete branch option set
  • Added entry to CHANGELOG.md

Related issues

Closes #166 (closed)

Edited by Lukas Riedel

Merge request reports