From 2fa695915937f56a4d150b29a41859ae7e22abf1 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Sun, 26 Jun 2011 14:58:03 +0200
Subject: Document hook helper functions

---
 man/7/caretaker.pod | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'man/7')

diff --git a/man/7/caretaker.pod b/man/7/caretaker.pod
index dd406d8..a856340 100644
--- a/man/7/caretaker.pod
+++ b/man/7/caretaker.pod
@@ -252,6 +252,29 @@ Sourced before a package is removed
 
 =back
 
+The following helper functions can be used for data aggregation into files /
+directories.  It should be noted that only the first argument is mandatory,
+they work fine with constructs like C<< collect_into_file
+${PKG_DIR}/.collected/ssh/config ${PKG_DIR}/*/provides/ssh/config(N) >>.
+
+=over
+
+=item B<collect_into_directory> I<directory> [I<files ...>]
+
+For each I<file>, create an absolute symlink pointing to it in I<directory>.
+
+Note that I<directory> must be used exclusively by this function: every time
+it runs, the directory will be wiped clean of all symlinks to make sure there
+are no broken ones (which would otherwise occur when removing a related
+package).
+
+=item B<collect_into_file> I<outfile> [I<infiles ...>]
+
+Concatenate the content of I<infiles> into I<outfile>. If no I<infiles> are
+specified, produces an empty I<outfile>.
+
+=back
+
 =head1 COLLECTED PACKAGE FILES
 
 These files reside in F<$PKG_DIR/.collected> (subject to change).
-- 
cgit v1.2.3