]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/tmpfiles.d.xml
tmpfiles: don't adjust qgroups on existing subvolumes
[thirdparty/systemd.git] / man / tmpfiles.d.xml
index e2e2eac228d01fd2927025de575c1b77ff9f9d29..9f3660bd4615b30a050d448f1039000dbc05c229 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
+<?xml version='1.0'?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!--
   SPDX-License-Identifier: LGPL-2.1+
@@ -185,68 +185,47 @@ L     /tmp/foobar -    -    -    -   /dev/null</programlisting>
 
         <varlistentry>
           <term><varname>q</varname></term>
-          <listitem><para>Similar to <varname>v</varname>. However,
-          makes sure that the subvolume will be assigned to the same
-          higher-level quota groups as the subvolume it has been
-          created in. This ensures that higher-level limits and
-          accounting applied to the parent subvolume also include the
-          specified subvolume. On non-btrfs file systems, this line
-          type is identical to <varname>d</varname>. If the subvolume
-          already exists and is already assigned to one or more higher
-          level quota groups, no change to the quota hierarchy is
-          made. Also see <varname>Q</varname> below. See <citerefentry
-          project='die-net'><refentrytitle>btrfs-qgroup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-          for details about the btrfs quota group
-          concept.</para></listitem>
+          <listitem><para>Similar to <varname>v</varname>. However, makes sure that the subvolume will be assigned to
+          the same higher-level quota groups as the subvolume it has been created in. This ensures that higher-level
+          limits and accounting applied to the parent subvolume also include the specified subvolume. On non-btrfs file
+          systems, this line type is identical to <varname>d</varname>.</para>
+
+          <para>If the subvolume already exists, no change to the quota hierarchy is made, regardless of whether the
+          subvolume is already attached to a quota group or not. Also see <varname>Q</varname> below. See <citerefentry
+          project='die-net'><refentrytitle>btrfs-qgroup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
+          details about the btrfs quota group concept.</para></listitem>
         </varlistentry>
 
         <varlistentry>
           <term><varname>Q</varname></term>
-          <listitem><para>Similar to <varname>q</varname>. However,
-          instead of copying the higher-level quota group assignments
-          from the parent as-is, the lowest quota group of the parent
-          subvolume is determined that is not the leaf quota
-          group. Then, an "intermediary" quota group is inserted that
-          is one level below this level, and shares the same ID part
-          as the specified subvolume. If no higher-level quota group
-          exists for the parent subvolume, a new quota group at level
-          255 sharing the same ID as the specified subvolume is
-          inserted instead. This new intermediary quota group is then
-          assigned to the parent subvolume's higher-level quota
-          groups, and the specified subvolume's leaf quota group is
-          assigned to it.</para>
-
-          <para>Effectively, this has a similar effect as
-          <varname>q</varname>, however introduces a new higher-level
-          quota group for the specified subvolume that may be used to
-          enforce limits and accounting to the specified subvolume and
-          children subvolume created within it. Thus, by creating
-          subvolumes only via <varname>q</varname> and
-          <varname>Q</varname>, a concept of "subtree quotas" is
-          implemented. Each subvolume for which <varname>Q</varname>
-          is set will get a "subtree" quota group created, and all
-          child subvolumes created within it will be assigned to
-          it. Each subvolume for which <varname>q</varname> is set
-          will not get such a "subtree" quota group, but it is ensured
-          that they are added to the same "subtree" quota group as their
-          immediate parents.</para>
-
-          <para>It is recommended to use
-          <varname>Q</varname> for subvolumes that typically contain
-          further subvolumes, and where it is desirable to have
-          accounting and quota limits on all child subvolumes
-          together. Examples for <varname>Q</varname> are typically
-          <filename>/home</filename> or
-          <filename>/var/lib/machines</filename>. In contrast,
-          <varname>q</varname> should be used for subvolumes that
-          either usually do not include further subvolumes or where no
-          accounting and quota limits are needed that apply to all
-          child subvolumes together. Examples for <varname>q</varname>
-          are typically <filename>/var</filename> or
-          <filename>/var/tmp</filename>. As with <varname>Q</varname>,
-          <varname>q</varname> has no effect on the quota group
-          hierarchy if the subvolume exists and already has at least
-          one higher-level quota group assigned.</para></listitem>
+          <listitem><para>Similar to <varname>q</varname>. However, instead of copying the higher-level quota group
+          assignments from the parent as-is, the lowest quota group of the parent subvolume is determined that is not
+          the leaf quota group. Then, an "intermediary" quota group is inserted that is one level below this level, and
+          shares the same ID part as the specified subvolume. If no higher-level quota group exists for the parent
+          subvolume, a new quota group at level 255 sharing the same ID as the specified subvolume is inserted
+          instead. This new intermediary quota group is then assigned to the parent subvolume's higher-level quota
+          groups, and the specified subvolume's leaf quota group is assigned to it.</para>
+
+          <para>Effectively, this has a similar effect as <varname>q</varname>, however introduces a new higher-level
+          quota group for the specified subvolume that may be used to enforce limits and accounting to the specified
+          subvolume and children subvolume created within it. Thus, by creating subvolumes only via
+          <varname>q</varname> and <varname>Q</varname>, a concept of "subtree quotas" is implemented. Each subvolume
+          for which <varname>Q</varname> is set will get a "subtree" quota group created, and all child subvolumes
+          created within it will be assigned to it. Each subvolume for which <varname>q</varname> is set will not get
+          such a "subtree" quota group, but it is ensured that they are added to the same "subtree" quota group as
+          their immediate parents.</para>
+
+          <para>It is recommended to use <varname>Q</varname> for subvolumes that typically contain further subvolumes,
+          and where it is desirable to have accounting and quota limits on all child subvolumes together. Examples for
+          <varname>Q</varname> are typically <filename>/home</filename> or <filename>/var/lib/machines</filename>. In
+          contrast, <varname>q</varname> should be used for subvolumes that either usually do not include further
+          subvolumes or where no accounting and quota limits are needed that apply to all child subvolumes
+          together. Examples for <varname>q</varname> are typically <filename>/var</filename> or
+          <filename>/var/tmp</filename>. </para>
+
+          <para>As with <varname>q</varname>, <varname>Q</varname> has no effect on the quota group hierarchy if the
+          subvolume already exists, regardless of whether the subvolume already belong to a quota group or
+          not.</para></listitem>
         </varlistentry>
 
         <varlistentry>
@@ -638,7 +617,7 @@ r! /tmp/.X[0-9]*-lock</programlisting>
             <row>
               <entry><literal>%t</literal></entry>
               <entry>System or user runtime directory</entry>
-              <entry>In --user mode, this is the same <varname>$XDG_RUNTIME_DIR</varname>, and <filename>/run</filename> otherwise.</entry>
+              <entry>In <option>--user</option> mode, this is the same <varname>$XDG_RUNTIME_DIR</varname>, and <filename>/run</filename> otherwise.</entry>
             </row>
             <row>
               <entry><literal>%T</literal></entry>