Skip to content
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

Change ethtool features to use underscore instead of dashes #206

Open
1 of 2 tasks
tyll opened this issue Apr 24, 2020 · 1 comment
Open
1 of 2 tasks

Change ethtool features to use underscore instead of dashes #206

tyll opened this issue Apr 24, 2020 · 1 comment
Assignees
Labels
help wanted Possible issue for newcomers low impact estimated to make a low impact medium effort estimated to require a medium effort

Comments

@tyll
Copy link
Member

tyll commented Apr 24, 2020

As discussed in #189 (comment), the ethtool features should use underscores instead of dashes. Since we already introduced the names with dashes, they need to be supported.

Implementation plan:

  • make role accept features with underscores in addition to dashes and update documentation to mention only the values with underscores - if options using dashes and underscores are mixed, fail
  • add warnings when dashes are used
@tyll tyll added help wanted Possible issue for newcomers blocker Issue to fix for next release labels Apr 24, 2020
@tyll
Copy link
Member Author

tyll commented Apr 27, 2020

It would be great to introduce a marker for deprecated values ideally with extra information about what should be used instead to be able to do use this information also in the script from #208

Possible ideas:

Reference by string:

                ArgValidatorBool("esp-hw-offload", default_value=None, deprecated_by="esp_hw_offload"),
                ArgValidatorBool("esp_hw_offload", default_value=None),

or

Reference by object:

def __Init__self(self):
    esp_hw_offload=ArgValidatorBool("esp_hw_offload", default_value=None),
     ArgValidatorDict.__init__(
        self,
        name="features",
        nested=[
            ArgValidatorBool("esp-hw-offload", default_value=None, deprecated_by=esp_hw_offload),
            esp_hw_offload

I guess the string makes it easier in case a value moves to a different subtree of the dictionary. Other ideas are welcome, too.

@tyll tyll added low impact estimated to make a low impact medium effort estimated to require a medium effort and removed blocker Issue to fix for next release labels Aug 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Possible issue for newcomers low impact estimated to make a low impact medium effort estimated to require a medium effort
Projects
None yet
Development

No branches or pull requests

2 participants