diff options
| author | Colin Walters <walters@verbum.org> | 2017-04-14 10:34:38 -0400 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2017-04-24 16:09:51 +0000 |
| commit | 55603a0c5201278ea12b052abbe84ac856b3b657 (patch) | |
| tree | 977ba0752cbbd9e74ab04ad169f2bb3c90a6dd74 /man | |
| parent | 0c4aeff1cbed1c97f3461706f2d360d8c08b5183 (diff) | |
| download | ostree-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 'man')
| -rw-r--r-- | man/ostree-admin-config-diff.xml | 4 | ||||
| -rw-r--r-- | man/ostree-admin-deploy.xml | 2 | ||||
| -rw-r--r-- | man/ostree-admin-os-init.xml | 12 | ||||
| -rw-r--r-- | man/ostree-admin-switch.xml | 2 | ||||
| -rw-r--r-- | man/ostree-admin-upgrade.xml | 2 | ||||
| -rw-r--r-- | man/ostree.xml | 5 |
6 files changed, 16 insertions, 11 deletions
diff --git a/man/ostree-admin-config-diff.xml b/man/ostree-admin-config-diff.xml index 69209e49..256b02fe 100644 --- a/man/ostree-admin-config-diff.xml +++ b/man/ostree-admin-config-diff.xml @@ -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> diff --git a/man/ostree-admin-deploy.xml b/man/ostree-admin-deploy.xml index ef96203c..347a4ba9 100644 --- a/man/ostree-admin-deploy.xml +++ b/man/ostree-admin-deploy.xml @@ -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. diff --git a/man/ostree-admin-os-init.xml b/man/ostree-admin-os-init.xml index 77bd126a..10f02ad6 100644 --- a/man/ostree-admin-os-init.xml +++ b/man/ostree-admin-os-init.xml @@ -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> diff --git a/man/ostree-admin-switch.xml b/man/ostree-admin-switch.xml index 8072d6b9..86f9be40 100644 --- a/man/ostree-admin-switch.xml +++ b/man/ostree-admin-switch.xml @@ -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. diff --git a/man/ostree-admin-upgrade.xml b/man/ostree-admin-upgrade.xml index 7766c66e..51900b85 100644 --- a/man/ostree-admin-upgrade.xml +++ b/man/ostree-admin-upgrade.xml @@ -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. diff --git a/man/ostree.xml b/man/ostree.xml index e31d58b2..940d81d7 100644 --- a/man/ostree.xml +++ b/man/ostree.xml @@ -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 |