More validate module fixes (#39097)

* Fix type bool DOCUMENTATION issues
This commit is contained in:
John R Barker
2018-04-24 18:05:50 +01:00
committed by GitHub
parent b533ebe20d
commit 7c4b91844d
118 changed files with 187 additions and 398 deletions

View File

@@ -51,38 +51,38 @@ options:
version_added: "2.4"
description:
- Runs the specified command globally.
choices: [ true, false]
type: bool
default: false
aliases: [ global-command ]
prefer_source:
description:
- Forces installation from package sources when possible (see --prefer-source).
default: false
choices: [ true, false]
type: bool
aliases: [ prefer-source ]
prefer_dist:
description:
- Forces installation from package dist even for dev versions (see --prefer-dist).
default: false
choices: [ true, false]
type: bool
aliases: [ prefer-dist ]
no_dev:
description:
- Disables installation of require-dev packages (see --no-dev).
default: true
choices: [ true, false]
type: bool
aliases: [ no-dev ]
no_scripts:
description:
- Skips the execution of all scripts defined in composer.json (see --no-scripts).
default: false
choices: [ true, false]
type: bool
aliases: [ no-scripts ]
no_plugins:
description:
- Disables all plugins ( see --no-plugins ).
default: false
choices: [ true, false]
type: bool
aliases: [ no-plugins ]
optimize_autoloader:
description:
@@ -90,14 +90,14 @@ options:
- Convert PSR-0/4 autoloading to classmap to get a faster autoloader.
- Recommended especially for production, but can take a bit of time to run.
default: true
choices: [ true, false]
type: bool
aliases: [ optimize-autoloader ]
ignore_platform_reqs:
version_added: "2.0"
description:
- Ignore php, hhvm, lib-* and ext-* requirements and force the installation even if the local machine does not fulfill these.
default: false
choices: [ true, false]
type: bool
aliases: [ ignore-platform-reqs ]
requirements:
- php

View File

@@ -39,7 +39,7 @@ options:
description:
- Whether to include dependencies or not.
required: false
choices: [ "yes", "no" ]
type: bool
default: "yes"
repository:
description:
@@ -50,7 +50,7 @@ options:
description:
- Install gem in user's local gems cache or for all users
required: false
choices: ["yes", "no"]
type: bool
default: "yes"
version_added: "1.3"
executable:

View File

@@ -40,7 +40,7 @@ options:
- Install the node.js library globally
required: false
default: no
choices: [ "yes", "no" ]
type: bool
executable:
description:
- The executable location for npm.
@@ -48,16 +48,16 @@ options:
required: false
ignore_scripts:
description:
- Use the --ignore-scripts flag when installing.
- Use the C(--ignore-scripts) flag when installing.
required: false
choices: [ "yes", "no" ]
type: bool
default: no
version_added: "1.8"
production:
description:
- Install dependencies in production mode, excluding devDependencies
required: false
choices: [ "yes", "no" ]
type: bool
default: no
registry:
description:

View File

@@ -33,15 +33,12 @@ options:
description:
- state of the package
choices: [ 'present', 'absent', 'active', 'inactive' ]
required: false
default: present
update_cache:
description:
- update the package db first
required: false
default: "no"
choices: [ "yes", "no" ]
notes: []
type: bool
'''
EXAMPLES = '''
- macports:

View File

@@ -32,7 +32,6 @@ options:
description:
- state of the package
choices: [ 'present', 'absent' ]
required: false
default: present
force:
description:
@@ -49,16 +48,13 @@ options:
- "remove"
- "checksum"
- "removal-of-dependent-packages"
required: false
default: absent
version_added: "2.0"
update_cache:
description:
- update the package db first
required: false
default: "no"
choices: [ "yes", "no" ]
notes: []
type: bool
requirements:
- opkg
- python

View File

@@ -39,7 +39,7 @@ options:
cached:
description:
- Use local package base instead of fetching an updated one.
choices: [ 'yes', 'no' ]
type: bool
required: false
default: no
annotation:
@@ -81,7 +81,7 @@ options:
description:
- Remove automatically installed packages which are no longer needed.
required: false
choices: [ "yes", "no" ]
type: bool
default: no
author: "bleader (@bleader)"
notes:

View File

@@ -37,7 +37,7 @@ options:
use_packages:
description:
- use packages instead of ports whenever available
choices: [ 'yes', 'no' ]
type: bool
required: false
default: yes
author: "berenddeboer (@berenddeboer)"

View File

@@ -45,7 +45,7 @@ options:
- update the package database first
required: false
default: false
choices: [ true, false ]
type: bool
author: Kim Nørgaard (@KimNorgaard)
requirements: [ "Slackware >= 12.2" ]

View File

@@ -64,7 +64,7 @@ options:
description:
- Install/Remove category instead of a single package.
required: false
choices: ["true", "false"]
type: bool
version_added: "1.6"
'''

View File

@@ -101,8 +101,7 @@ options:
- Has an effect only if state is I(latest)
required: false
default: "no"
choices: ["yes", "no"]
aliases: []
type: bool
version_added: "2.5"
installroot:

View File

@@ -75,7 +75,7 @@ options:
I(present) or I(latest).
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
disable_recommends:
version_added: "1.8"
description:
@@ -83,21 +83,21 @@ options:
install recommended packages.
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
force:
version_added: "2.2"
description:
- Adds C(--force) option to I(zypper). Allows to downgrade packages and change vendor or architecture.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
update_cache:
version_added: "2.2"
description:
- Run the equivalent of C(zypper refresh) before the operation. Disabled in check mode.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
aliases: [ "refresh" ]
oldpackage:
version_added: "2.2"
@@ -106,7 +106,7 @@ options:
version is specified as part of the package name.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
extra_args:
version_added: "2.4"
required: false