From d4fc49fa6be78ada6f9dc3e86919825394e5fc9e Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Mon, 19 Nov 2012 15:13:57 +0100 Subject: [PATCH] begin manpage Signed-off-by: Nico Schottelius --- .../conf}/type/__git/gencode-remote | 0 cdist/conf/type/__git/man.text | 68 +++++++++++++++++++ {conf => cdist/conf}/type/__git/manifest | 0 .../conf}/type/__git/parameter/required | 0 4 files changed, 68 insertions(+) rename {conf => cdist/conf}/type/__git/gencode-remote (100%) create mode 100644 cdist/conf/type/__git/man.text rename {conf => cdist/conf}/type/__git/manifest (100%) rename {conf => cdist/conf}/type/__git/parameter/required (100%) diff --git a/conf/type/__git/gencode-remote b/cdist/conf/type/__git/gencode-remote similarity index 100% rename from conf/type/__git/gencode-remote rename to cdist/conf/type/__git/gencode-remote diff --git a/cdist/conf/type/__git/man.text b/cdist/conf/type/__git/man.text new file mode 100644 index 00000000..230f43c3 --- /dev/null +++ b/cdist/conf/type/__git/man.text @@ -0,0 +1,68 @@ +cdist-type__git(7) +================== +Nico Schottelius + + +NAME +---- +cdist-type__git - Get and or keep git repositories up-to-date + + +DESCRIPTION +----------- +This cdist type allows you to clone and keep git repositories +up-to-date. + + +REQUIRED PARAMETERS +------------------- +source:: + Specifies the git remote to clone from + + +OPTIONAL PARAMETERS +------------------- +name:: + If supplied, use the name and not the object id as the package name. + +state:: + Either "present" or "absent", defaults to "present" + +branch:: + The remote branch to check out + +BOOLEAN PARAMETERS +------------------ +up-to-date:: + Whether to git merge on each run + + +EXAMPLES +-------- + +-------------------------------------------------------------------------------- +# Create hard git of /etc/shadow +__git /home/services/dokuwiki --source /etc/shadow --type hard + +# Relative symbolic git +__git /etc/apache2/sites-enabled/www.test.ch \ + --source ../sites-available/www.test.ch \ + --type symbolic + +# Absolute symbolic git +__git /opt/plone --source /home/services/plone --type symbolic + +# Remove git +__git /opt/plone --state absent +-------------------------------------------------------------------------------- + + +SEE ALSO +-------- +- cdist-type(7) + + +COPYING +------- +Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is +granted under the terms of the GNU General Public License version 3 (GPLv3). diff --git a/conf/type/__git/manifest b/cdist/conf/type/__git/manifest similarity index 100% rename from conf/type/__git/manifest rename to cdist/conf/type/__git/manifest diff --git a/conf/type/__git/parameter/required b/cdist/conf/type/__git/parameter/required similarity index 100% rename from conf/type/__git/parameter/required rename to cdist/conf/type/__git/parameter/required