network create: add warning for deprecated macvlan flag #11402
Conversation
openshift-ci
bot
added
the
approved
| @@ -54,9 +55,9 @@ must be used with a *subnet* option. | |||
|
|
|||
| Set metadata for a network (e.g., --label mykey=value). | |||
|
|
|||
| #### **--macvlan** | |||
| #### **--macvlan**=*device* | |||
There was a problem hiding this comment.
I think we should just remove the documentation rather then telling users about it?
There was a problem hiding this comment.
I would like to keep it as long as the option still works. I want to remove this option for 4.0.
There was a problem hiding this comment.
The option can still be there, just no reason to document it. That way existing users will continue to use it, but no new users will accidentally start using it.
There was a problem hiding this comment.
Or perhaps we can add a "deprecated" note to this and then say as of 4.0 it's being removed.
There was a problem hiding this comment.
I think deprecated options should still be documented. This change clearly states this and what you should use instead. I could add that it is being removed with podman 4.0 but I am not sure if there is any reason to remove it.
There was a problem hiding this comment.
I disagree, if we don't want people to use or rely on an option, we should make the option disappear. 4.0 would allow us to break their scripts(Although I would recommend against that).
We can document in the release notes that it is depracated, and print a warning when users use it.
There was a problem hiding this comment.
I removed the flag from the man page and emit a warning when --macvlan is used.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Luap99, rhatdan The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
LGTM |
Luap99
changed the title
Luap99
force-pushed
the
macvlan-doc
branch
3 times, most recently
from
1ecd262 to
cd8c86e
Compare
Luap99
changed the title
The macvlan driver is not deprecated, only the --macvlan flag is. Remove the flag from the man page since it is deprecated and add a warning to podman network create if it is used. [NO TESTS NEEDED] Fixes containers#11400 Signed-off-by: Paul Holzinger <[email protected]>
|
Thanks @Luap99 |
github-actions
bot
added
the
locked - please file new issue/PR
The macvlan driver is not deprecated, only the --macvlan flag is.
Remove the flag from the man page since it is deprecated and add a
warning to podman network create if it is used.
Fixes #11400
Signed-off-by: Paul Holzinger [email protected]