From be2a349970b2ad6e88229e837118e9a4317cfcc6 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Thu, 7 Mar 2019 01:05:15 +0530 Subject: [PATCH] become: Add missing documentation for pfexec, dzdo and machinectl (#53314) Signed-off-by: Abhijeet Kasurde --- docs/bin/plugin_formatter.py | 7 ++++++- lib/ansible/plugins/become/pfexec.py | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/bin/plugin_formatter.py b/docs/bin/plugin_formatter.py index 11db00b6dee..408c946f656 100755 --- a/docs/bin/plugin_formatter.py +++ b/docs/bin/plugin_formatter.py @@ -554,7 +554,12 @@ def process_plugins(module_map, templates, outputname, output_dir, ansible_versi display.v('about to template %s' % module) display.vvvvv(pp.pformat(doc)) - text = templates['plugin'].render(doc) + try: + text = templates['plugin'].render(doc) + except Exception as e: + display.warning(msg="Could not parse %s due to %s" % (module, e)) + continue + if LooseVersion(jinja2.__version__) < LooseVersion('2.10'): # jinja2 < 2.10's indent filter indents blank lines. Cleanup text = re.sub(' +\n', '\n', text) diff --git a/lib/ansible/plugins/become/pfexec.py b/lib/ansible/plugins/become/pfexec.py index 1e1835f1cc5..cef870a6d61 100644 --- a/lib/ansible/plugins/become/pfexec.py +++ b/lib/ansible/plugins/become/pfexec.py @@ -15,7 +15,7 @@ DOCUMENTATION = """ become_user: description: - User you 'become' to execute the task - - This plugin ignores this settingas pfexec uses it's own ``exec_attr`` to figure this out, + - This plugin ignores this setting as pfexec uses it's own ``exec_attr`` to figure this out, but it is supplied here for Ansible to make decisions needed for the task execution, like file permissions. default: root ini: @@ -80,6 +80,7 @@ DOCUMENTATION = """ vars: - name: ansible_pfexec_wrap_execution env: + - name: ANSIBLE_PFEXEC_WRAP_EXECUTION note: - This plugin ignores ``become_user`` as pfexec uses it's own ``exec_attr`` to figure this out. """