From 3055ca2cc04383104efb134ac2d67077c0fcb108 Mon Sep 17 00:00:00 2001 From: AlexisLessard Date: Tue, 7 Aug 2018 12:48:29 -0400 Subject: [PATCH] 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. --- lib/ansible/modules/packaging/os/yum_repository.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/ansible/modules/packaging/os/yum_repository.py b/lib/ansible/modules/packaging/os/yum_repository.py index a19bef12d3..bb23c197a3 100644 --- a/lib/ansible/modules/packaging/os/yum_repository.py +++ b/lib/ansible/modules/packaging/os/yum_repository.py @@ -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