1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Clarifications of parameters in yum_repo module (#38453)

* Clarifications of parameters in yum_repo module

Added a note defining where the "name" parameter of the module will appear in the repo file and note explaining that the description parameter of the module is actually the name parameter in the repo file. It might help people transform their existing yum repository files in ansible managed repos.
This commit is contained in:
AlexisLessard 2018-08-07 12:48:29 -04:00 committed by Alicia Cozine
parent 5936e1f449
commit 3055ca2cc0

View file

@ -69,7 +69,7 @@ options:
default: 75
description:
description:
- A human readable string describing the repository.
- A human readable string describing the repository. This option corresponds to the "name" property in the repo file.
- This parameter is only required if I(state) is set to C(present).
enabled:
description:
@ -201,7 +201,7 @@ options:
default: 21600
name:
description:
- Unique repository ID.
- Unique repository ID. This option builds the section name of the repository in the repo file.
- This parameter is only required if I(state) is set to C(present) or
C(absent).
required: true