Add an EnforcementPolicy for deprecated elements #543
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This can be used to configure whether the parser will emit a warning or an error when encountering a deprecated element. Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
azeey
added this to In progress
in SDFormat Development TRI (Moved to https://github.com/orgs/ignitionrobotics/projects/6)
via automation
aaronchongth
approved these changes
Apr 22, 2021
EricCousineau-TRI
approved these changes
Apr 22, 2021
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
azeey
force-pushed
the
config_deprecation_error
branch
from
109dd41
to
eebf49b
Compare
|
I believe I've addressed all the feedback. @EricCousineau-TRI , PTAL. |
|
All of this looks great, thanks! |
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
SDFormat Development TRI (Moved to https://github.com/orgs/ignitionrobotics/projects/6)
automation
moved this from In progress
to Done
Apr 29, 2021
5 tasks
nkoenig
removed this from Done
in SDFormat Development TRI (Moved to https://github.com/orgs/ignitionrobotics/projects/6)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎉 New feature
Closes #541
Summary
If the warning policy of the parser is set to
ERRin thesdf::ParserConfig, the parser emits an error message for deprecated elements. This PR adds a separateEnforcementPolicyfor deprecated elements so that the behavior of the parser can be configured by the user. The API is such, by defaultDeprecatedElementsPolicyreflects the value ofWarninPolicy, but the user can callSetDeprecatedElementsPolicyto override the value. Note that the order of the function calls does not matter. Once theDeprecatedElementsPolicyoverridden, callingWarninPolicywill not change the value ofDeprecatedElementsPolicyunlessResetDeprecatedElementsPolicyis called. I'm open to feedback on this API.Test it
Tests are in
test/integration/deprecated_specs.ccChecklist
sh tools/code_check.sh)another open pull request
to support the maintainers
Note to maintainers: Remember to use Squash-Merge
🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸