Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man: improve sysroot.readonly docs #3099

Merged
merged 1 commit into from
Nov 27, 2023
Merged

man: improve sysroot.readonly docs #3099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions man/ostree-prepare-root.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
</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>
option is enabled, instead a writable bind mount for <literal>/sysroot/etc</literal>, and everything else
is mounted read-only.
option is enabled, then <literal>/sysroot/sysroot</literal> is mounted read-only to provide further protection and a writable bind mount for
<literal>/sysroot/etc</literal> is created.
</para>

<para>
Expand All @@ -111,7 +111,7 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
<variablelist>
<varlistentry>
<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>
<term><varname>etc.transient</varname></term>
Expand Down
9 changes: 9 additions & 0 deletions man/ostree.repo-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,15 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.

<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>
<term><varname>bootloader</varname></term>
<listitem><para>Configure the bootloader that OSTree uses when
Expand Down
Loading