docs/reference: stop, restart: add flag descriptions #5484
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5484 +/- ##
===========================================
+ Coverage 43.17% 60.03% +16.86%
===========================================
Files 6 345 +339
Lines 227 23434 +23207
===========================================
+ Hits 98 14068 +13970
- Misses 123 8391 +8268
- Partials 6 975 +969 |
|
/cc @dvdksn ptal 🤗 |
Benehiko
reviewed
Sep 27, 2024
dvdksn
reviewed
Sep 27, 2024
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
stop_restart_flag_descriptions
branch
from
35d3dde
to
6075303
Compare
thaJeztah
commented
Sep 27, 2024
Comment on lines
+52
to
+55
| The default timeout can be specified using the [`--stop-timeout`](https://docs.docker.com/reference/cli/docker/container/run/#stop-timeout) | ||
| option when creating the container. If no default is configured for the container, | ||
| the Daemon determines the default, and is 10 seconds for Linux containers, and | ||
| 30 seconds for Windows containers. |
There was a problem hiding this comment.
TBH; not super happy with these sections; we should probably have a look at better descriptions for these (we have this in some other places as well).
It's a bit complicated to explain these bits
- container inherits default from image (which can be set through dockerfile)
- or overridden at runtime (
docker create/docker run) - or overridden when invoking these commands
- or otherwise use the daemon default (which can differ per platform)
Some of that could become more transparent if we had better separation between "desired config" and "actual config" (in which case we could make defaults visible in inspect output), but we don't have that.
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.
- A picture of a cute animal (not mandatory but encouraged)