ansible-doc fix displaying 'CLI' options for plugin docs

cli options will now display either use provided info, or automating from the name Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
ansible · Jun 4, 2021 · 26827f5 · 26827f5
1 parent 6a883f1
commit 26827f5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/changelogs/fragments/doc_knows_cli.yml b/changelogs/fragments/doc_knows_cli.yml
@@ -0,0 +1,2 @@
+minor_changes:
+  - ansible-doc pretty cli options output.
diff --git a/lib/ansible/cli/doc.py b/lib/ansible/cli/doc.py
@@ -1043,6 +1043,15 @@ def add_fields(text, fields, limit, opt_indent, return_values=False, base_indent
                             if ignore in item:
                                 del item[ignore]
 
+            if 'cli' in opt and opt['cli']:
+                conf['cli'] = []
+                for cli in opt['cli']:
+                    if 'option' not in cli:
+                        conf['cli'].append({'name': cli['name'], 'option': '--%s' % cli['name'].replace('_', '-')})
+                    else:
+                        conf['cli'].append(cli)
+                del opt['cli']
+
             if conf:
                 text.append(DocCLI._dump_yaml({'set_via': conf}, opt_indent))
 

diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py
@@ -232,6 +232,7 @@
             - name: ansible_ssh_private_key_file
           cli:
             - name: private_key_file
+              option: '--private-key'
 
       control_path:
         description: