summaryrefslogtreecommitdiff
path: root/init.d/README
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2007-11-05 16:00:32 -0500
committerJoey Hess <joey@kodama.kitenet.net>2007-11-05 16:00:32 -0500
commit34320131ce680fe03febc9f4d6b438f05e548cbc (patch)
tree41c91d7ad68331e1fa2525c43d43e6c04899b09b /init.d/README
parent3e6cf464cff47d22f4ac4b4313fda68f32ae1ea8 (diff)
rename etc-* to etckeeper-*
Diffstat (limited to 'init.d/README')
-rw-r--r--init.d/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/init.d/README b/init.d/README
new file mode 100644
index 0000000..90aec67
--- /dev/null
+++ b/init.d/README
@@ -0,0 +1,13 @@
+Executable files in this directory are run to initialise the working directory
+for use by etckeeper. If the working directory is not already in version
+control, that includes setting up the version control, but not actually
+committing anything. If the working directory is in version control,
+it includes applying stored metadata to the checked out files in the
+working directory.
+
+Please be careful to *never* overwrite existing files/directories
+in the working directory (or use absolute care when doing so). If a file
+you need to write already exists, check if its contents are sane, and
+if not, emit a warning on stderr.
+
+If initialisation fails, exit nonzero and no later files will be run.