From 27286c787dc468451ebaeb84ca6e20134462c574 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Mon, 14 Mar 2011 23:12:14 +0100 Subject: [PATCH] document files/ directories (in object and type) Signed-off-by: Nico Schottelius --- doc/man/cdist-type.text | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/man/cdist-type.text b/doc/man/cdist-type.text index 7c8b49f3..f8811a16 100644 --- a/doc/man/cdist-type.text +++ b/doc/man/cdist-type.text @@ -179,6 +179,14 @@ level tools like ruby installed. If a type requires specific tools to be present on the target, there must be another type that provides this tool and the first type should create an object of the specific type. +If your type wants to save temporay data, that may be used by other types +later on (for instance __file), you can save them in the subdirectory +"files" below $__object (but you must create it yourself). cdist will not touch +this directory. + +If your type contains static files, it's also recommened to place them in +a folder named "files" within the type (again, because cdist guarantees to +never ever touch this folder). HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST -----------------------------------------