From c06c68253b90670ca66f22be40ffbd198f22145f Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Sat, 30 Sep 2017 13:14:20 +0000
Subject: Add doc precisions about live compiled dbs
---
doc/s6-rc-compile.html | 17 +++++++++++++++++
doc/s6-rc-init.html | 4 ++++
doc/s6-rc-update.html | 5 +++++
3 files changed, 26 insertions(+)
diff --git a/doc/s6-rc-compile.html b/doc/s6-rc-compile.html
index d78e7ad..d23f071 100644
--- a/doc/s6-rc-compile.html
+++ b/doc/s6-rc-compile.html
@@ -374,6 +374,23 @@ instance managed by an automatically generated longrun service named
s6rc-fdholder.
+ Compiled database usage
+
+
+ - Once it has been built with s6-rc-compile, a compiled database cannot be
+modified. It (i.e. the directory containing the n, db and
+resolve.cdb files as well as the servicedirs
+
- Once a compiled database is live (i.e. it has services running on it,
+following an invocation of s6-rc-init or
+s6-rc-update, it must not move anymore,
+and it must not be deleted. The only way to "free" such a compiled database
+for displacement or deletion is to replace it as the live one via another
+call to s6-rc-update.
+
+
+
A complete example
diff --git a/doc/s6-rc-init.html b/doc/s6-rc-init.html
index 54692bf..f3a7bb1 100644
--- a/doc/s6-rc-init.html
+++ b/doc/s6-rc-init.html
@@ -129,6 +129,10 @@ compiled service databases into some versioned directory, and that
use. This will make it easier to create new compiled databases and
switch them with s6-rc-update
without having to change the s6-rc-init invocation in boot scripts.
+
After s6-rc-init runs, compiled has become the
+"live compiled database", and must not be tampered with or deleted.
+The only way to free it for deletion is to replace it with another
+database, via a call to s6-rc-update.