From 6fc2d7953120668622f0cb3e4f771084eb77ca4c Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 30 Oct 2025 21:48:44 +0000 Subject: Add missing doc pages --- doc/s6-rc-set-commit.html | 118 +++++++++++++++++++++++++++++++++++++++++++ doc/s6-rc-set-install.html | 106 ++++++++++++++++++++++++++++++++++++++ src/repo/s6-rc-set-install.c | 2 +- 3 files changed, 225 insertions(+), 1 deletion(-) create mode 100644 doc/s6-rc-set-commit.html create mode 100644 doc/s6-rc-set-install.html diff --git a/doc/s6-rc-set-commit.html b/doc/s6-rc-set-commit.html new file mode 100644 index 0000000..a331d00 --- /dev/null +++ b/doc/s6-rc-set-commit.html @@ -0,0 +1,118 @@ + + + + + + s6-rc: the s6-rc-set-commit program + + + + + + +

+s6-rc
+Software
+skarnet.org +

+ +

The s6-rc-set-commit program

+ +

+ s6-rc-set-commit compiles a set of services, +ensuring it is ready for installation. +

+ +

Interface

+ +
+     s6-rc-set-commit [ -v verbosity ] [ -r repo ] [ -D defaultbundle ] [ -h fdhuser ] [ -K ] [ -f ] set
+
+ + + +

Options

+ +
+
-v verbosity, --verbosity=verbosity
+
Be more or less verbose. The default is 1, which means +that error messages and warnings will be written to stderr. 0 means that only +error messages will be written, and 2 or more adds informational messages.
+ +
-r repo, --repository=repo
+
Use the repository in repo, which must exist. Default is +/var/lib/s6-rc/repository. +
+ +
-D defaultbundle, --default-bundle=defaultbundle
+
This option specifies the name of the bundle that will contain all the active and +essential services. It should be the name that is used to bring up the machine at +boot time when invoking the s6-rc change command. The +default is default.
+ +
-h fdhuser, --fdholder-user=fdhuser
+
Specifies fdhuser as the user the fd-holder daemon will run +at if the service database is installed and booted on. The default is +root, which is fine, but paranoid users may want to +specify a non-root account.
+ +
-K, --keep-old
+
If this option is given: if there is a previous compiled database for set set, +it will be kept around. On sucess, s6-rc-set-commit will print a line to stdout +that is the path to the old compiled database. You can copy it with +cp -PR, move it with mv or delete it with rm -r. +By default, old compiled databases are not kept — they're deleted when +a new commit operation succeeds.
+ +
-f, --force
+
Force a new compilation even if a compiled database already exists for +the set and it has not changed since the last commit. By default, when a +compiled version of set exists and is more recent than the last +change to the source version, s6-rc-set-commit notices it and does nothing.
+
+ +

Exit codes

+ +
+
0
Success.
+
1
The set failed to compile.
+
3
set was not found in the repository. +
100
Incorrect usage.
+
102
Inconsistent repository.
+
111
System call failed.
+
+ +

Notes

+ + + + + diff --git a/doc/s6-rc-set-install.html b/doc/s6-rc-set-install.html new file mode 100644 index 0000000..02b01f8 --- /dev/null +++ b/doc/s6-rc-set-install.html @@ -0,0 +1,106 @@ + + + + + + s6-rc: the s6-rc-set-install program + + + + + + +

+s6-rc
+Software
+skarnet.org +

+ +

The s6-rc-set-install program

+ +

+ s6-rc-set-install installs a committed +set of services, i.e. a compiled database, as +the live database of the currently running system. +

+ +

+ It is basically a wrapper around s6-rc-update. +

+ +

Interface

+ +
+     s6-rc-set-install [ -v verbosity ] [ -r repo ] [ -l livedir ] [ -f convfile ] [ -b ] [ -K ] set bootdbdir
+
+ + + +

Options

+ +
+
-v verbosity, --verbosity=verbosity
+
Be more or less verbose. The default is 1, which means +that error messages and warnings will be written to stderr. 0 means that only +error messages will be written, and 2 or more adds informational messages.
+ +
-r repo, --repository=repo
+
Use the repository in repo, which must exist. Default is +/var/lib/s6-rc/repository.
+ +
-l livedir, --livedir=livedir
+
Assume the live directory of the machine, as created by +s6-rc-init, is livedir. The default +is /run/s6-rc, but may have been changed at s6-rc +build time with the --livedir configure argument.
+ +
-f convfile, --conversion-file=convfile
+
Specifies a conversion file to give to +s6-rc-update. The default is not having +a conversion file, which should be correct in most cases.
+ +
-b, --block
+
Pass the -b option to s6-rc-update, +which makes it block rather than fail when the live database is currently being +used by another program - typically when an s6-rc change +transition is under way.
+ +
-K, --keep-old
+
If this option is given, the old live database, after it has been +replaced, is kapt around, and s6-rc-set-install prints a line to stdout that +is the path to that old database. It can e.g. be used by automation to keep +the possibility of rollbacks. +By default, s6-rc-set-install will delete the old live database after +successfully updating to the new one.
+
+ +

Exit codes

+ +
+
0
Success.
+
3
set was not found in the repository. +
7
set was not up-to-date. +
100
Incorrect usage.
+
102
Inconsistent repository.
+
111
System call failed.
+
Other codes
s6-rc-set-install can also exit with +exit codes from s6-rc-update.
+
+ +

Notes

+ + + + + diff --git a/src/repo/s6-rc-set-install.c b/src/repo/s6-rc-set-install.c index 2e0b7a0..e8893b2 100644 --- a/src/repo/s6-rc-set-install.c +++ b/src/repo/s6-rc-set-install.c @@ -82,7 +82,7 @@ int main (int argc, char const *const *argv) r = s6rc_repo_setuptodate(wgola[GOLA_REPODIR], argv[0]) ; if (r == -1) _exit(111) ; - if (!r) strerr_dief3x(1, "set ", argv[0], " is not up-to-date; commit it first") ; + if (!r) strerr_dief3x(7, "set ", argv[0], " is not up-to-date; commit it first") ; { size_t repolen = strlen(wgola[GOLA_REPODIR]) ; -- cgit v1.3.1