Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expand list of internal variables #55935

Closed
acozine opened this issue Apr 30, 2019 · 11 comments · Fixed by #79118
Closed

Expand list of internal variables #55935

acozine opened this issue Apr 30, 2019 · 11 comments · Fixed by #79118
Labels
affects_2.11 affects_2.13 docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. easyfix This issue is considered easy to fix by aspiring contributors. support:core This issue/PR relates to code supported by the Ansible Engineering Team.

Comments

@acozine
Copy link
Contributor

acozine commented Apr 30, 2019

SUMMARY

Per @bcoca, the list of internal arguments on https://docs.ansible.com/ansible/devel/dev_guide/developing_program_flow_modules.html is incomplete. Document the rest of these args:

_ansible_module_name, _ansible_string_conversion_action, _ansible_keep_remote_files, _ansible_socket, _ansible_shell_executable, _ansible_tmpdir, _ansible_remote_tmp

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

dev_guide

ANSIBLE VERSION

2.9

CONFIGURATION

N/A

OS / ENVIRONMENT

N/A
@acozine acozine mentioned this issue Apr 30, 2019
Merged
@ansibot
Copy link
Contributor

ansibot commented Apr 30, 2019

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Apr 30, 2019

cc @gundalow
click here for bot help

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Apr 30, 2019
@samdoran samdoran removed the needs_triage Needs a first human triage before being processed. label Apr 30, 2019
@acozine acozine mentioned this issue May 21, 2019
Open
3 tasks
@ansibot
Copy link
Contributor

ansibot commented Jul 27, 2019

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added the has_pr This issue has an associated PR. label Jul 27, 2019
@ansibot
Copy link
Contributor

ansibot commented Sep 25, 2019

Files identified in the description:

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

@bcoca
Copy link
Member

bcoca commented Dec 18, 2020

We can generate from PASS_VARS and PASS_BOOLS constants in lib/ansible/module_utils/common/parameters.py

@bcoca bcoca added affects_2.11 and removed affects_2.9 This issue/PR affects Ansible v2.9 labels Dec 18, 2020
@bcoca bcoca added affects_2.13 easyfix This issue is considered easy to fix by aspiring contributors. and removed has_pr This issue has an associated PR. labels Feb 16, 2022
@ansibot
Copy link
Contributor

ansibot commented May 6, 2022

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Jun 7, 2022

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@JaroslavKlech
Copy link
Contributor

I can work on this.

@JaroslavKlech
Copy link
Contributor

JaroslavKlech commented Sep 23, 2022 •
edited

Hello @bcoca, could you please help me and give me some pointers about where I could get some content about these arguments that we need to document in https://docs.ansible.com/ansible/devel/dev_guide/developing_program_flow_modules.html

arguments to be added:
_ansible_module_name, _ansible_string_conversion_action, _ansible_keep_remote_files, _ansible_socket, _ansible_shell_executable, _ansible_tmpdir, _ansible_remote_tmp

@bcoca
Copy link
Member

bcoca commented Sep 23, 2022

https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/action/__init__.py#L958

@bcoca
Copy link
Member

bcoca commented Sep 23, 2022

https://github.com/ansible/ansible/blob/devel/lib/ansible/module_utils/common/parameters.py#L87

@JaroslavKlech JaroslavKlech mentioned this issue Oct 12, 2022
Merged
@ansible ansible locked and limited conversation to collaborators Nov 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
affects_2.11 affects_2.13 docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. easyfix This issue is considered easy to fix by aspiring contributors. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

iss#55935: Documents missing internal parameters and polishes 'Intern… JaroslavKlech/ansible
5 participants
@bcoca @acozine @samdoran @ansibot @JaroslavKlech