supervision - discussion about system services, daemon supervision, init, runlevel management, and tools such as s6 and runit
 help / color / mirror / Atom feed
From: Adam Joseph <adam@westernsemico.com>
To: supervision@list.skarnet.org
Cc: Adam Joseph <adam@westernsemico.com>
Subject: [PATCH 1/2] doc/s6-rc-compile.html: document bundle flattening
Date: Mon, 25 Sep 2023 17:41:16 -0700	[thread overview]
Message-ID: <20230926004117.23478-1-adam@westernsemico.com> (raw)

This commit adds a single sentence explaining that nested bundles
are flattened by s6-rc-compile; the fact that one bundle contains
another (rather than merely happening to contain all the atomics
that the latter contains) is not preserved by s6-rc-compile.

Although this is the most reasonable handling it is not the only
possible handling.  I had to read the source code in order to make
sure that bundle nesting was not represented in the output of
s6-rc-compile, and figured that adding a mention of this fact to the
documentation might save others the trouble.

More importantly, the special rules for singleton bundles (see next
patch in series) depend on this flattening behavior.

Signed-off-by: Adam Joseph <adam@westernsemico.com>
---
 doc/s6-rc-compile.html | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/s6-rc-compile.html b/doc/s6-rc-compile.html
index e1ad82b..ef06893 100644
--- a/doc/s6-rc-compile.html
+++ b/doc/s6-rc-compile.html
@@ -136,6 +136,9 @@ deprecated. </li>
 <tt>contents</tt> file.
 However, if s6-rc-compile detects a cycle in bundle definitions, it will
 complain and exit 1.
+Bundles are flattened during compilation: a parent bundle which
+contains a child bundle will be compiled as if the parent bundle had
+directly included the child bundle's contents.
 </p>
 
 <h3> For atomic services </h3>
-- 
2.41.0


             reply	other threads:[~2023-09-26  0:42 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-26  0:41 Adam Joseph [this message]
2023-09-26  0:41 ` [PATCH 2/2] doc: define "singleton bundle", document special rules Adam Joseph

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230926004117.23478-1-adam@westernsemico.com \
    --to=adam@westernsemico.com \
    --cc=supervision@list.skarnet.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).