Fix module documentation

ansible-doc is reporting several issues in modules. Most of them have benn
due to misspelled description key word or due to use of multi line text
without the | in the description line.
This commit is contained in:
Thomas Woerner
2020-09-21 14:31:47 +02:00
parent 6c7f433135
commit cf9fb2e870
12 changed files with 99 additions and 91 deletions

View File

@@ -30,8 +30,7 @@ DOCUMENTATION = '''
---
module: ipaclient_fix_ca
short description: Fix IPA ca certificate
description:
Repair Fix IPA ca certificate
description: Repair Fix IPA ca certificate
options:
servers:
description: Fully qualified name of IPA servers to enroll to
@@ -43,7 +42,7 @@ options:
description: The basedn of the IPA server (of the form dc=example,dc=com)
required: no
allow_repair:
description:
description: |
Allow repair of already joined hosts. Contrary to ipaclient_force_join
the host entry will not be changed on the server
required: no

View File

@@ -32,8 +32,7 @@ DOCUMENTATION = '''
---
module: ipaclient_fstore
short description: Backup files using IPA client sysrestore
description:
Backup files using IPA client sysrestore
description: Backup files using IPA client sysrestore
options:
backup:
description: File to backup

View File

@@ -32,8 +32,7 @@ DOCUMENTATION = '''
---
module: ipaclient_setup_nss
short description: Create IPA client NSS database
description:
Create IPA NSS database
description: Create IPA NSS database
options:
servers:
description: Fully qualified name of IPA servers to enroll to
@@ -55,7 +54,7 @@ options:
User Principal allowed to promote replicas and join IPA realm
required: yes
subject_base:
description:
description: |
The certificate subject base (default O=<realm-name>).
RDNs are in LDAP order (most specific RDN first).
required: no
@@ -72,12 +71,12 @@ options:
description: The installer dnsok setting
required: yes
enable_dns_updates:
description:
description: |
Configures the machine to attempt dns updates when the ip address
changes
required: yes
all_ip_addresses:
description:
description: |
All routable IP addresses configured on any interface will be added
to DNS
required: yes

View File

@@ -34,7 +34,7 @@ DOCUMENTATION = '''
---
module: ipareplica_prepare
short description: Prepare ipa replica installation
description:
description: |
Prepare ipa replica installation: Create IPA configuration file, run install
checks again and also update the host name and the hosts file if needed.
The tests and also the results from ipareplica_test are needed.