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
This commit is contained in:
Colin Walters authored and Atomic Bot committed 2017-04-24 16:09:51 +00:00
1 parent 0c4aeff1cb
commit 55603a0c52
10 files changed
+37 -25

No files matched your search

+2 -2
View File
@@ -66,10 +66,10 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<term><option>--os</option>="STATEROOT"</term>
<listitem><para>
Use a different operating system root than the current one.
Use a different operating system stateroot than the current one.
</para></listitem>
</varlistentry>
</variablelist>
+1 -1
View File
@@ -66,7 +66,7 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<term><option>--os</option>="STATEROOT"</term>
<listitem><para>
Use a different operating system root than the current one.
+8 -4
View File
@@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree admin os-init</command> <arg choice="req">OSNAME</arg>
<command>ostree admin os-init</command> <arg choice="req">STATEROOT</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -57,15 +57,19 @@ Boston, MA 02111-1307, USA.
<title>Description</title>
<para>
Initializes an new state for an operating system. Ensures that the core subdirectories of /var (/tmp, /lib, /run, and /lock) exist and initialize the given OSNAME as OSTree root. Each deployment location is comprised of a single shared <filename>var</filename> and a set of deployments (chroots).
Initializes an new stateroot (AKA "osname") for an operating system.
Ensures that the core subdirectories of /var (/tmp, /lib, /run, and
/lock) exist and initialize the given STATEROOT as OSTree stateroot.
Each deployment location is comprised of a single shared
<filename>var</filename> and a set of deployments (chroots).
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree admin os-init gnome-ostree</command></para>
<para><command>$ ostree admin os-init exampleos</command></para>
<programlisting>
ostree/deploy/gnome-ostree initialized as OSTree root
ostree/deploy/exampleos initialized as OSTree root
</programlisting>
</refsect1>
</refentry>
+1 -1
View File
@@ -66,7 +66,7 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<term><option>--os</option>="STATEROOT"</term>
<listitem><para>
Use a different operating system root than the current one.
+1 -1
View File
@@ -69,7 +69,7 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>--os</option>="OSNAME"</term>
<term><option>--os</option>="STATEROOT"</term>
<listitem><para>
Use a different operating system root than the current one.
+3 -2
View File
@@ -65,8 +65,9 @@ Boston, MA 02111-1307, USA.
Instead, they parallel install to the new toplevel
<filename>/ostree</filename> directory. Each
installed system gets its own
<filename>/ostree/deploy/<replaceable>osname</replaceable></filename>
directory.
<filename>/ostree/deploy/<replaceable>stateroot</replaceable></filename>
directory. (<literal>stateroot</literal> is the
newer term for <literal>osname</literal>).
</para>
<para>
Unlike <literal>rpm</literal> or