Fix short_description flag in plugins, role modules and templates

Before "short description" was used in most plugins, modules and also
in the new module templates.

ansible-doc was therefore not showing the short description. To fix the
issue the flag was renamed to short_description instead.

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=2121362
       'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'
This commit is contained in:
Thomas Woerner
2022-08-26 15:19:33 +02:00
parent e05dc41e0f
commit 81143be96a
94 changed files with 94 additions and 94 deletions

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_enable_ipa
short description: Enable IPA
short_description: Enable IPA
description: Enable IPA
options:
hostname:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_load_cache
short description: Load cache file
short_description: Load cache file
description: Load cache file
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_master_password
short description: Generate kerberos master password if not given
short_description: Generate kerberos master password if not given
description:
Generate kerberos master password if not given
options:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_prepare
short description: Prepare IPA server deployment
short_description: Prepare IPA server deployment
description: Prepare IPA server deployment
options:
force:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_set_ds_password
short description: Set DS password
short_description: Set DS password
description: Set DS password
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_adtrust
short description: Setup trust ad
short_description: Setup trust ad
description: Setup trust ad
options:
hostname:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_ca
short description: Setup CA
short_description: Setup CA
description: Setup CA
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_custodia
short description: Setup custodia
short_description: Setup custodia
description: Setup custodia
options:
realm:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_dns
short description: Setup DNS
short_description: Setup DNS
description: Setup DNS
options:
ip_addresses:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_ds
short description: Configure directory server
short_description: Configure directory server
description: Configure directory server
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_http
short description: Setup HTTP
short_description: Setup HTTP
description: Setup HTTP
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_kra
short description: Setup KRA
short_description: Setup KRA
description: Setup KRA
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_krb
short description: Setup KRB
short_description: Setup KRB
description: Setup KRB
options:
dm_password:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_ntp
short description: Setup NTP
short_description: Setup NTP
description: Setup NTP
options:
ntp_servers:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_setup_otpd
short description: Setup OTPD
short_description: Setup OTPD
description: Setup OTPD
options:
realm:

View File

@@ -34,7 +34,7 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
module: ipaserver_test
short description: IPA server test
short_description: IPA server test
description: IPA server test
options:
force: