cli/command/container: stop, restart: rename "--time" to "--timeout" #5485
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 renames the `--time` flag as used on `docker stop` and `docker restart` to `--timeout`, bringing it in line with other uses for this property, such as `--stop-timeout` on `docker run`. The `--time` option is deprecated and hidden, but will be kept for backward compatibility, as these options existed for a long time. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5485 +/- ##
==========================================
+ Coverage 60.03% 60.04% +0.01%
==========================================
Files 345 345
Lines 23434 23440 +6
==========================================
+ Hits 14068 14074 +6
Misses 8391 8391
Partials 975 975 |
|
@krissetto @laurazard I kept the flag descriptions unmodified for now, as that required more discussion; this one is only renaming the flag to |
krissetto
approved these changes
Sep 27, 2024
| @@ -30,8 +30,11 @@ func NewRestartCommand(dockerCli command.Cli) *cobra.Command { | |||
| Short: "Restart one or more containers", | |||
| Args: cli.RequiresMinArgs(1), | |||
| RunE: func(cmd *cobra.Command, args []string) error { | |||
| if cmd.Flags().Changed("time") && cmd.Flags().Changed("timeout") { | |||
| return errors.New("conflicting options: either specify --timeout or --time, not both") | |||
There was a problem hiding this comment.
Thinking of these error messages a bit..instead of telling the users "multiple things" (the error: what to do, and what not to do), what do you think of something like this (the error: description)?
conflicting options: --timeout and --time cannot be used together
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.
This renames the
--timeflag as used ondocker stopanddocker restartto--timeout, bringing it in line with other uses for this property, such as--stop-timeoutondocker run.The
--timeoption is deprecated and hidden, but will be kept for backward compatibility, as these options existed for a long time.- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)