module DOCUMANTATION for apt, apt_respository cleanup

This commit is contained in:
Jan-Piet Mens
2012-09-29 01:51:55 +02:00
parent ce5dceab0e
commit 1193810d46
2 changed files with 27 additions and 46 deletions

View File

@@ -26,7 +26,7 @@
DOCUMENTATION = '''
---
module: apt_repository
short_description: Manages apt repositores (such as for Debian/Ubuntu).
short_description: Manages apt repositores
description:
- Manages apt repositores (such as for Debian/Ubuntu).
version_added: "0.7"
@@ -43,22 +43,16 @@ options:
default: present
choices: [ "present", "absent" ]
notes:
- This module require 'apt-add-repository' wwill be available on destination server. To ensure this package is available use 'apt' module and install 'python-software-properties' package before use this module.
- This module work only on Ubuntu and unstable Debian, see U(https://github.com/ansible/ansible/pull/1082, this issue)
- A bug in 'apt-add-repository' always add 'deb' and 'deb-src' type for repo (see the U(https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264, issue on lunchpad)), if some repo don't have source (eg: MongoDB repo from 10gen) the system fail on update repositories.
- This module requires C(apt-add-repository) be available on destination server. To ensure this package is available use the C(apt) module and install the C(python-software-properties) package before using this module.
- This module works on Ubuntu and unstable Debian only, see U(https://github.com/ansible/ansible/pull/1082).
- A bug in C(apt-add-repository) always adds C(deb) and C(deb-src) types for repositories (see the issue on Launchpad U(https://bugs.launchpad.net/ubuntu/+source/software-properties/+bug/987264)), if some repo don't have source (eg: MongoDB repo from 10gen) the system fails while updating repositories.
author: Matt Wright
'''
EXAMPLES = [
"""
examples:
- code: apt_repository repo=ppa://nginx/stable
description: Add nginx stable repository from PPA
""",
"""
- code: apt_repository repo='deb http://archive.canonical.com/ubuntu hardy partner'
description: Add specified repository into sources.
"""
]
'''
import platform