Inform user that the yum metadata cache remains (#19753)

This PR improves the documentation so that it is clear that this module does
not clean the repository metadata cache on removal, and add an example
notification handler to the removal example as an extra reminder.

This fixes #19730
This commit is contained in:
Dag Wieers 2017-01-05 19:30:37 +01:00 committed by Matt Davis
parent 74db76ec9c
commit e1fe403075

View file

@ -398,6 +398,8 @@ notes:
- Parameters in a section are ordered alphabetically in an existing repo
file.
- The repo file will be automatically deleted if it contains no repository.
- When removing a repository, beware that the metadata cache may still remain
on disk until you run C(yum clean all). Use a notification handler for this.
'''
EXAMPLES = '''
@ -424,10 +426,18 @@ EXAMPLES = '''
mirrorlist: http://mirrorlist.repoforge.org/el7/mirrors-rpmforge
enabled: no
- name: Remove repository
# Handler showing how to clean yum metadata cache
- name: yum-clean-metadata
command: yum clean metadata
args:
warn: no
# Example removing a repository and cleaning up metadata cache
- name: Remove repository (and clean up left-over metadata)
yum_repository:
name: epel
state: absent
notify: yum-clean-all
- name: Remove repository from a specific repo file
yum_repository: