shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2025-01-03 05:18:24 +03:00
Code Issues Projects Releases Wiki Activity

man: improve sysroot.readonly docs

Browse Source 
The explanation of sysroot.readonly is a little confusing - we say
that "everything else is mounted read-only" but it's perhaps clearer
to say /sysroot is mounted read-only.

Also note that read-only is the default with composefs.

Finally, document the option in ostree.repo-config even though it is
now considered legacy - as of commit 22b8e4f9 (#2930) - it is still
commonly seen in repo configs, so users will look to understand
what it means.
This commit is contained in:
Mark McLoughlin 2023-11-24 14:27:11 +00:00
parent cd1728a4bf
commit 2cfa8aba72
No known key found for this signature in database
GPG Key ID: 65091615C98A3808
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
man/ostree-prepare-root.xml
View File

@ -85,10 +85,10 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
</para> </para>
<para> <para>
A read-only bind mount is created over <literal>/sysroot/usr</literal>. The immutable bit is set on the deployment A read-only bind mount is created over <literal>/sysroot/usr</literal>. The immutable bit (see chattr(1)) is set on the deployment
root, so this provides basic protection for filesystem mutation. If the <literal>sysroot.readonly</literal> root, so this provides basic protection for filesystem mutation. If the <literal>sysroot.readonly</literal>
option is enabled, instead a writable bind mount for <literal>/sysroot/etc</literal>, and everything else option is enabled, then <literal>/sysroot/sysroot</literal> is mounted read-only to provide further protection and a writable bind mount for
is mounted read-only. <literal>/sysroot/etc</literal> is created.
</para> </para>
<para> <para>
@ -111,7 +111,7 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>sysroot.readonly</varname></term> <term><varname>sysroot.readonly</varname></term>
<listitem><para>A boolean value; the default is <literal>false</literal>. If this is set to <literal>true</literal>, then the <literal>/sysroot</literal> mount point is mounted read-only.</para></listitem> <listitem><para>A boolean value; the default is <literal>false</literal> unless composefs is enabled. If this is set to <literal>true</literal>, then the <literal>/sysroot</literal> mount point is mounted read-only.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>etc.transient</varname></term> <term><varname>etc.transient</varname></term>

9
man/ostree.repo-config.xml
View File

@ -378,6 +378,15 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
<variablelist> <variablelist>
<varlistentry>
<term><varname>readonly</varname></term>
<listitem><para>A boolean value. If this is set to <literal>true</literal>, then the
<literal>/sysroot</literal> mount point is mounted read-only. This is configured a
legacy repository configuration and the equivalent option in <literal>ostree/prepare-root.conf</literal>
should be used instead - see <citerefentry><refentrytitle>ostree-prepare-root</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><varname>bootloader</varname></term> <term><varname>bootloader</varname></term>
<listitem><para>Configure the bootloader that OSTree uses when <listitem><para>Configure the bootloader that OSTree uses when