Skip to content
Snippets Groups Projects
Commit 0579a364 authored by Thomas Bellman's avatar Thomas Bellman
Browse files

Document parameters of directory_parents definition.

parent 9fbec315
No related branches found
No related tags found
No related merge requests found
...@@ -6,6 +6,26 @@ ...@@ -6,6 +6,26 @@
* Create the directories from $top down to, but not including, $name. * Create the directories from $top down to, but not including, $name.
* This is somewhat similar to the Unix command 'mkdir -p'. * This is somewhat similar to the Unix command 'mkdir -p'.
* *
* Parameters:
*
* - name A file name, one level below the lowest level of
* directories to manage.
*
* - top The highest parent directory to manage. This must be a
* parent (or grand-parent, or great-...-grand-parent) of
* $name. In particular, it is an error if $top == $name.
*
* - owner, group, mode
* Owner, group and mode of directories; same meanings as
* in the 'file' type.
*
* - purge If set to true, unmanaged files and directories below
* $top will be cleaned away. Note that $name is not
* managed by this definition, and is thus a candidate for
* removal unless managed elsewhere. The intermediate
* directories inbetween $name and $top are however
* regarded as managed.
*
* Example: * Example:
* *
* cfgfile::directory_parents { * cfgfile::directory_parents {
...@@ -15,9 +35,7 @@ ...@@ -15,9 +35,7 @@
* *
* This will create and manage the directories: * This will create and manage the directories:
* *
* /opt/foo * /opt/foo /opt/foo/fie /opt/foo/fie/fum
* /opt/foo/fie
* /opt/foo/fie/fum
* *
* However, /opt/foo/fie/fum/gazonk.del will be left unmanaged, to * However, /opt/foo/fie/fum/gazonk.del will be left unmanaged, to
* (presumably) be managed elsewhere. * (presumably) be managed elsewhere.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment