cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

ansible-doc: show correct plugin name (#71966) (#71984)

Browse source 
(cherry picked from commit 0c3a9c7ae6)
This commit is contained in:
Felix Fontein 2020-09-28 18:36:00 +02:00 committed by GitHub
parent 4df129c6ae
commit 8e00447aef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/71966-ansible-doc-plugin-name.yml Normal file
View file

@ -0,0 +1,2 @@
bugfixes:
- "ansible-doc - properly show plugin name when ``name:`` is used instead of ``<plugin_type>:`` (https://github.com/ansible/ansible/pull/71966)."

6
lib/ansible/cli/doc.py
View file

@ -385,7 +385,7 @@ class DocCLI(CLI):
text = DocCLI.get_snippet_text(doc)
else:
try:
text = DocCLI.get_man_text(doc, collection_name)
text = DocCLI.get_man_text(doc, collection_name, plugin_type)
except Exception as e:
raise AnsibleError("Unable to retrieve documentation from '%s' due to: %s" % (plugin, to_native(e)))
@ -619,7 +619,7 @@ class DocCLI(CLI):
text.append('')
@staticmethod
def get_man_text(doc, collection_name=''):
def get_man_text(doc, collection_name='', plugin_type=''):
# Create a copy so we don't modify the original
doc = dict(doc)
@ -629,7 +629,7 @@ class DocCLI(CLI):
pad = display.columns * 0.20
limit = max(display.columns - int(pad), 70)
plugin_name = doc.get(context.CLIARGS['type'], doc.get('plugin_type'))
plugin_name = doc.get(context.CLIARGS['type'], doc.get('name')) or doc.get('plugin_type') or plugin_type
if collection_name:
plugin_name = '%s.%s' % (collection_name, plugin_name)