Mark default-bridge-only opts in --help and manpage #49522
Conversation
Signed-off-by: Rob Murray <rob.murray@docker.com>
| or **--fixed-cidr-v6** can be used to override the subnet. IPv6 forwarding | ||
| will be enabled if not used with **--ip-forward=false**. This may collide | ||
| with your host's current IPv6 settings. For more information consult the | ||
| documentation about "Advanced Networking - IPv6". |
There was a problem hiding this comment.
I think it would be ok to provide the URL directly, WDYT?
There was a problem hiding this comment.
Link could be useful; probably would require a printed link I guess? Not sure if we're currently including links in the dockerd man-page, also knowing that it's used by others, which may have their own docs 🤔
|
For the docs, we probably need to (manually) update the "usage" output in https://github.com/docker/cli/blob/master/docs/reference/dockerd.md (When doing so, I tend to slightly adjust the actual output to minimise diff if there's whitespace changes) We still need to look at moving those docs over (and if possible also generate a YAML-docs for it to have the flag descriptions in structured format) |
|
I think a nice improvement would be to look if we can use the "Groups" added in Cobra (spf13/cobra#1003), although I think currently they're limited to subcommands and not yet have an equivalent for options (flags). It'd be possible for us to use a custom annotation for that though; I did something similar originally in docker/cli to group commands. If we do, we ned to update the Cobra template we use, as we're currently overriding the default template with our own, which was based on a very old version of Cobra, so may be missing new features/info added in later versions; Line 49 in 0de01f7 |
thaJeztah
left a comment
There was a problem hiding this comment.
LGTM
I see this was added to the v28.1.0 milestone, was that intended to be v28.0.1 or do we want to keep this for the next minor version? (either way could make sense)
Oh, thank you ... I was aiming for 28.0.1. I'll update it. |
|
Thx! I think this removes at least some of the ambiguity in these options; let's bring this in 👍 |
- What I did
Several dockerd options only apply to the default bridge network, but they look like global config.
Try to make that clear in
--helpoutput and the manpage.For review - is https://docs.docker.com/reference/cli/dockerd/ generated by running
dockerd --help, or do I need to update something else?- How I did it
- How to verify it
- Human readable description for the release notes