docs(login): note --tls-verify needs = for false - #7022
Conversation
Boolean flags treat a bare --tls-verify as true; --tls-verify false is parsed as a registry name. Document the = form used in the examples. Fixes: podman-container-tools#6375 Signed-off-by: Dean Chen <862469039@qq.com>
| `--tls-verify=false`). A bare `--tls-verify` is treated as true; a space-separated | ||
| form such as `--tls-verify false` is not accepted (the word after the flag is | ||
| parsed as a registry name). | ||
|
|
There was a problem hiding this comment.
Your thought is good, but I'd rather it be worked into the prior paragraph, as this is kind of a boolean+ option and true can operate differently depending on how it is defined. Perhaps:
Require HTTPS and certificate verification when talking to container registries (default: true). As this is a boolean value, use the = form when passing a value, for example, --tls-verify=false.
If explicitly set to true,
then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified,
TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf.
TLS verification cannot be used when talking to an insecure registry. Note: a space-separated form such as --tls-verify false is not accepted (the word after the flag is
parsed as a registry name).
Signed-off-by: Dean Chen <862469039@qq.com>
|
fair — folded the = form note into the main paragraph instead of a separate block. |
2 participants
--tls-verifyis a bool flag, so a bare--tls-verifymeans true and--tls-verify falseis not a value assignment (the next token is treated as the registry). The examples already use--tls-verify=false; spelled that out next to the option so it is less surprising.Fixes #6375