add details on some plugin options - AI-assisted #2813
+32
−5
Conversation
This file contains hidden or 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
| Each entry includes a ``name`` field specifying the environment variable name. | ||
| The name should be in uppercase and should be prefixed with the collection name. | ||
| Multiple environment variables can be listed for the same option. | ||
| The first environment variable in the list takes precedence if multiple are set. |
There was a problem hiding this comment.
The first environment variable in the list takes precedence if multiple are set.
Isn't it the other way around? Both according to ansible-community/antsibull-docs#139 and to what my tests just showed, the last entry wins.
| **ini** | ||
| List of configuration file settings that can be used to set this option. | ||
| Each entry includes a ``section`` field for the configuration file section and a ``key`` field for the configuration key. Both should be in lowercase and should be prefixed with the collection name. | ||
| Multiple configuration settings can be listed for the same option. |
There was a problem hiding this comment.
It should also mention here which one wins if multiple are specified.
| List of Ansible variables that can be used to set this option. | ||
| Each entry includes a ``name`` field specifying the variable name. | ||
| The name should be in lowercase and should be prefixed with the collection name. | ||
| Multiple variables can be listed for the same option. |
| Variables follow Ansible's variable precedence rules. | ||
| This allows plugins to be configured via Ansible variables. | ||
|
|
||
|
|
There was a problem hiding this comment.
Finally some precedence of env, ini, vars, and direct specification (possible for some plugin types, like lookup and inventory) should be listed. From my tests:
- direct specification always wins;
- next come Ansible variables;
- then come environment variables;
- then come ansible.cfg values;
- last comes the option's default value, resp.
Noneif there is no default.
(I didn't check keywords and CLI settings; according to ansible-community/antsibull-docs#139 (comment) they come between Ansible variables and environment variables.)
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.
Fixes #2673
Should have done this in 2 commits (AI-generated, then human adapted). Lines 78-93 are predominantly generated.