From 0d0bc5e620a9332c19531b85a4d4563d1ef455e0 Mon Sep 17 00:00:00 2001 From: Marco Vito Moscaritolo Date: Sat, 29 Sep 2012 16:28:55 +0200 Subject: [PATCH] Added DOCUMENTATION to subversion module. --- library/subversion | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/library/subversion b/library/subversion index 1b659c76697..a44894db9c8 100755 --- a/library/subversion +++ b/library/subversion @@ -18,12 +18,38 @@ # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . -# I wanted to keep this simple at first, so for now this checks out -# from the given branch of a repo at a particular SHA or -# tag. Latest is not supported, you should not be doing -# that. Contribs welcome! -- MPD - -# requires subversion and grep on the client. +DOCUMENTATION = ''' +--- +module: subversion +short_description: Deploys a subversion repository. +description: + - This module is really simple, so for now this checks out from the given branch of a repo at a particular SHA or tag. Latest is not supported, you should not be doing that. +version_added: "0.7" +options: + repo: + description: + - The subversion URL to the repository. + required: true + default: null + dest: + description: + - Absolute path where the repository should be deployed. + required: true + default: null + force: + description: + - If yes, any modified files in the working repository will be discarded. If no, this module will fail if it encounters modified files. + required: false + default: yes + choices: [ "yes", "no" ] +examples: + - code: subversion repo=svn+ssh://an.example.org/path/to/repo dest=/src/checkout + description: Export subversion repository in a specified folder +notes: + - Requires subversion and grep on the client. +requirements: [ ] +author: Dane Summers +''' import re