summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2017-04-14 10:34:38 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2017-04-24 16:09:51 +0000
commit55603a0c5201278ea12b052abbe84ac856b3b657 (patch)
tree977ba0752cbbd9e74ab04ad169f2bb3c90a6dd74 /docs
parent0c4aeff1cbed1c97f3461706f2d360d8c08b5183 (diff)
downloadostree-55603a0c5201278ea12b052abbe84ac856b3b657.tar.gz
Rename "osname" → "stateroot"
I never really liked the term "osname". I feel "stateroot" is a *lot* clearer, since the osname/stateroot mostly just holds `/var`. Further it avoids the `os` prefix which is already overloaded. Some of the existing docs already talked about "operating system state", which further reinforces this. There's *lot* more things than this which reference the term "osname", but I don't want to change *everything* yet in this patch in case we decide to do something different - this just gets the highlights. Closes: #794 Approved by: jlebon
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/atomic-upgrades.md2
-rw-r--r--docs/manual/deployment.md25
-rw-r--r--docs/manual/introduction.md2
3 files changed, 15 insertions, 14 deletions
diff --git a/docs/manual/atomic-upgrades.md b/docs/manual/atomic-upgrades.md
index a60656a8..341372d0 100644
--- a/docs/manual/atomic-upgrades.md
+++ b/docs/manual/atomic-upgrades.md
@@ -55,7 +55,7 @@ checking it back out of the repo into a deployment.
## Assembling a new deployment directory
Given a commit to deploy, OSTree first allocates a directory for
-it. This is of the form `/boot/loader/entries/ostree-$osname-$checksum.$serial.conf`.
+it. This is of the form `/boot/loader/entries/ostree-$stateroot-$checksum.$serial.conf`.
The `$serial` is normally `0`, but if a
given commit is deployed more than once, it will be incremented.
This is supported because the previous deployment may have
diff --git a/docs/manual/deployment.md b/docs/manual/deployment.md
index 51554c4f..76d05701 100644
--- a/docs/manual/deployment.md
+++ b/docs/manual/deployment.md
@@ -8,23 +8,24 @@ operating systems (accessible via `ostree admin`). The core content of these op
are treated as read-only, but they transparently share storage.
A deployment is physically located at a path of the form
-`/ostree/deploy/$osname/deploy/$checksum`.
+`/ostree/deploy/$stateroot/deploy/$checksum`.
OSTree is designed to boot directly into exactly one deployment
at a time; each deployment is intended to be a target for
`chroot()` or equivalent.
-### "osname": Group of deployments that share /var
+### "stateroot" (AKA "osname"): Group of deployments that share /var
-Each deployment is grouped in exactly one "osname". From above, you
-can see that an osname is physically represented in the
-`/ostree/deploy/$osname` directory. For example, OSTree can allow
-parallel installing Debian in `/ostree/deploy/debian` and Red Hat
-Enterprise Linux in `/ostree/deploy/rhel` (subject to operating system
-support, present released versions of these operating systems may not
-support this).
+Each deployment is grouped in exactly one "stateroot" (also known as an "osname");
+the former term is preferred.
-Each osname has exactly one copy of the traditional Unix `/var`,
-stored physically in `/ostree/deploy/$osname/var`. OSTree provides
+From above, you can see that an stateroot is physically represented in the
+`/ostree/deploy/$stateroot` directory. For example, OSTree can allow parallel
+installing Debian in `/ostree/deploy/debian` and Red Hat Enterprise Linux in
+`/ostree/deploy/rhel` (subject to operating system support, present released
+versions of these operating systems may not support this).
+
+Each stateroot has exactly one copy of the traditional Unix `/var`,
+stored physically in `/ostree/deploy/$stateroot/var`. OSTree provides
support tools for `systemd` to create a Linux bind mount that ensures
the booted deployment sees the shared copy of `/var`.
@@ -81,7 +82,7 @@ files.
When a tree is deployed, it will have a configuration file generated
of the form
-`/boot/loader/entries/ostree-$osname-$checksum.$serial.conf`. This
+`/boot/loader/entries/ostree-$stateroot-$checksum.$serial.conf`. This
configuration file will include a special `ostree=` kernel argument
that allows the initramfs to find (and `chroot()` into) the specified
deployment.
diff --git a/docs/manual/introduction.md b/docs/manual/introduction.md
index c88d6c14..6cde8ddd 100644
--- a/docs/manual/introduction.md
+++ b/docs/manual/introduction.md
@@ -97,7 +97,7 @@ parallel install inside an existing OS or distribution
occupying the physical `/` root.
On each client machine, there is an OSTree repository stored
-in `/ostree/repo`, and a set of "deployments" stored in `/ostree/deploy/$OSNAME/$CHECKSUM`.
+in `/ostree/repo`, and a set of "deployments" stored in `/ostree/deploy/$STATEROOT/$CHECKSUM`.
Each deployment is primarily composed of a set of hardlinks
into the repository. This means each version is deduplicated;
an upgrade process only costs disk space proportional to the