document config-init.sh better

[invirt/packages/invirt-base.git] / files / lib / init / config-init.sh

diff --git a/files/lib/init/config-init.sh b/files/lib/init/config-init.sh
index d9d1f76..33ea582 100644 (file)
--- a/files/lib/init/config-init.sh
+++ b/files/lib/init/config-init.sh
@@ -1,12 +1,18 @@
 # For a package which only configures another, "parent" package.
 #
-# Global variable PARENTPACKAGE names parent; unset for no parent,
-# array for (zero or one or) many parents.
+# Usage:
+#   PACKAGE=short-name
+#   GEN_FILES=(files to generate)
+#   PARENTPACKAGE=(parent-package another-parent-package)
+#   . /lib/init/config-init.sh
+#   config_init "$1"
 #
-# Global variable PACKAGE names this package, for log message.
+# PACKAGE       - name to appear in log message
+# GEN_FILES     - files to be generated with gen-files.sh
+# PARENTPACKAGE - packages to receive start, etc, commands passed through
 #
-# If BASH_VERSION is null or unset, accepts only one parent in
-# PARENTPACKAGE, or empty for zero.
+# Global variables GEN_FILES, PARENTPACKAGE may be unset for zero
+# values, or scalars for one.  If run under sh, they cannot be arrays.
 
 . /lib/init/vars.sh
 . /lib/lsb/init-functions