From 5e95d487982b9362b544139b98d1da55fa6ef78c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/bin/compile-db.html | 98 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 doc/bin/compile-db.html (limited to 'doc/bin/compile-db.html') diff --git a/doc/bin/compile-db.html b/doc/bin/compile-db.html new file mode 100644 index 0000000..c0ed957 --- /dev/null +++ b/doc/bin/compile-db.html @@ -0,0 +1,98 @@ + + + + + + + compile-db + + + +

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+ +

The compile-db program

+ compile-db is a helper script for use by other software + that compiles a general confdir + tries to use the result to update a general + livedir. +

Interface

     compile-db confdir livedir

+ compile-db runs + s6-rc-compile + on confdir/src/*. +
+ This creates a new confdir/@xyz@_db + file with @xyz@ based on the current UNIX time. +
+ If livedir exists, that is, + a goetia based supervision tree is running, + compile-db the tries to update the live state at livedir + to @xyz@_db using + s6-rc-update. +
+ If it succeeds, it updates the symlink + confdir/compiled + to point to + confdir/@xyz@_db + and deletes the old database + confdir/@abc@_db. +
+ If it does not succeed, + it runs s6-rc-update to switch back to + confdir/compiled + which points to + confdir/@abc@_db. + Followed by deleting + confdir/@xyz@_db. +

Exit codes

+ 0: success +
+ Since compile-db is an + execline + script, it exits with an approximation + of employed program that failed. +
+ compile-db mostly uses + execline + and + s6 + software, the exit behaviour of which can be looked up on + their respective pages. +
+ See also: + execline exit code handling. +

Options

+ There are no otions to compile-db. +

+ + -- cgit v1.2.3