Clarify documentation of SKIP_VERIFY #12203
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
cipherboy
force-pushed
the
fix-skip-verify-docs
branch
from
e847f79
to
9139bda
Compare
|
Please also sync to here. |
GiteaBot
added
the
lgtm/need 2
The documentation clearly documents the empty value as the default, however at least one user reported this as being unclear. Mark values explicitly so it is clear what values it can take. This clarifies that an empty value in fact leaves certificate verification enabled, whereas it has to be explicitly set to true to disable certificate verification. Resolves: go-gitea#12117 Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
cipherboy
force-pushed
the
fix-skip-verify-docs
branch
from
9139bda
to
df0e7d9
Compare
|
ACK, done. Thanks @silverwind. |
mrsdizzie
suggested changes
Jul 10, 2020
There was a problem hiding this comment.
I think we should only use true/false for boolean examples and not mention empty. While empty will always evaluate to false, having it as a 3rd option seems to be what caused the original confusion this is meant to fix. Showing false as the default makes that more clear. Also slight change to comment just so it is the same between both files
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
|
Sorry, was out of internet range. Updated! |
mrsdizzie
approved these changes
Jul 20, 2020
GiteaBot
added
lgtm/need 1
silverwind
approved these changes
Jul 21, 2020
GiteaBot
added
lgtm/done
techknowlogick
added
the
skip-changelog
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The documentation clearly documents the empty value as the default,
however at least one user reported this as being unclear. Mark values
explicitly so it is clear what values it can take. This clarifies that
an empty value in fact leaves certificate verification enabled, whereas
it has to be explicitly set to true to disable certificate verification.
Resolves: #12117
Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>