[doc] Improve "proxy" configuration option documentation (RhBug:2072332) #1824
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
lukash
reviewed
Apr 22, 2022
| @@ -955,10 +955,10 @@ configuration. | |||
| ``proxy`` | |||
| :ref:`string <string-label>` | |||
|
|
|||
| URL of a proxy server to connect through. Set to an empty string to disable the proxy setting inherited from the main section and use direct connection instead. The expected format of this option is ``<scheme>://<ip-or-hostname>[:port]``. | |||
| URL of a proxy server to connect through. Set to an empty string in the repository configuration to disable proxy setting inherited from the main section. The expected format of this option is ``<scheme>://<ip-or-hostname>[:port]``. | |||
There was a problem hiding this comment.
I think it's better without "the" here but it's also fine the way it is:
... in repository configuration ...
| (For backward compatibility, '_none_' can be used instead of the empty string.) | ||
|
|
||
| Note: The curl environment variables (such as ``http_proxy``) are effective if this option is unset. See the ``curl`` man page for details. | ||
| Note: The curl environment variables (such as ``http_proxy``) are effective if this option is unset (or '_none_' is set in the repository configuration). See the ``curl`` man page for details. |
There was a problem hiding this comment.
I'd remove the paretheses but again it's just fine the way it is:
... is unset or 'none' is set in the repository configuration.
|
+1 |
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.
No description provided.