Changes to Yum Documentation (#41054)

* added an example for a list of packages to install and added C() to some areas since it cannot be read right
* fixed the changes to list for
This commit is contained in:
Jonathan Lozada D 2018-06-08 06:11:01 -04:00 committed by Abhijeet Kasurde
parent 1ce484831b
commit 0061ec4a09

View file

@ -28,7 +28,7 @@ options:
- A package name or package specifier with version, like C(name-1.0). - A package name or package specifier with version, like C(name-1.0).
- If a previous version is specified, the task also needs to turn C(allow_downgrade) on. - If a previous version is specified, the task also needs to turn C(allow_downgrade) on.
See the C(allow_downgrade) documentation for caveats with downgrading packages. See the C(allow_downgrade) documentation for caveats with downgrading packages.
- When using state=latest, this can be '*' which means run C(yum -y update). - When using state=latest, this can be C('*') which means run C(yum -y update).
- You can also pass a url or a local path to a rpm file (using state=present). - You can also pass a url or a local path to a rpm file (using state=present).
To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages. To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages.
aliases: [ pkg ] aliases: [ pkg ]
@ -52,13 +52,13 @@ options:
description: description:
- I(Repoid) of repositories to enable for the install/update operation. - I(Repoid) of repositories to enable for the install/update operation.
These repos will not persist beyond the transaction. These repos will not persist beyond the transaction.
When specifying multiple repos, separate them with a ",". When specifying multiple repos, separate them with a C(",").
version_added: "0.9" version_added: "0.9"
disablerepo: disablerepo:
description: description:
- I(Repoid) of repositories to disable for the install/update operation. - I(Repoid) of repositories to disable for the install/update operation.
These repos will not persist beyond the transaction. These repos will not persist beyond the transaction.
When specifying multiple repos, separate them with a ",". When specifying multiple repos, separate them with a C(",").
version_added: "0.9" version_added: "0.9"
conf_file: conf_file:
description: description:
@ -73,8 +73,7 @@ options:
version_added: "1.2" version_added: "1.2"
skip_broken: skip_broken:
description: description:
- Resolve depsolve problems by removing packages that are causing problems from the trans - Skip packages with broken dependencies(devsolve) and are causing problems.
action.
type: bool type: bool
default: "no" default: "no"
version_added: "2.3" version_added: "2.3"
@ -253,6 +252,14 @@ EXAMPLES = '''
yum: yum:
name: sos name: sos
disablerepo: "epel,ol7_latest" disablerepo: "epel,ol7_latest"
- name: Install a list of packages
yum:
name:
- nginx
- postgresql
- postgresql-server
state: present
''' '''
import os import os