Whamcloud - gitweb
LUDOC-511 pool: reserved poolname "inherit" and "ignore" 12/52712/3
authorEtienne AUJAMES <etienne.aujames@cea.fr>
Mon, 16 Oct 2023 15:08:40 +0000 (17:08 +0200)
committerAndreas Dilger <adilger@whamcloud.com>
Mon, 16 Oct 2023 15:29:56 +0000 (15:29 +0000)
Add documentation for the special/reserved poolname "inherit" and
"ignore".

These reserved names were added by the patch:
https://review.whamcloud.com/46955 ("LU-15707 lod: force creation of a
component without a pool")

Change-Id: I411a810ed79c9d647d7d9a5e59066d33abb9ee21
Signed-off-by: Etienne AUJAMES <eaujames@ddn.com>
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/52712
Tested-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
ManagingFileSystemIO.xml
ManagingStripingFreeSpace.xml

index 4c75acb..f4651cb 100644 (file)
@@ -435,6 +435,27 @@ client# lfs setstripe [--size|-s stripe_size] [--offset|-o start_ost]
           other modifiers. For example, you can set striping on a directory to
           use an explicit starting index.</para>
         </note>
+        <note condition='l2G'>
+          <para>There are several reserved pool keywords:</para>
+          <itemizedlist>
+            <listitem>
+              <para>Use
+                <emphasis role="bold">
+                  <literal>--pool '' or --pool inherit</literal></emphasis>
+                to  force a component to inherit the pool from the parent or
+                root directory instead of the previous PFL's component (see
+                <xref linkend="pfl" />).</para>
+            </listitem>
+            <listitem>
+              <para>Use
+                <emphasis role="bold">
+                  <literal>--pool ignore</literal></emphasis>
+                to force creation of a file or a PFL's component without a pool
+                set (no inheritance from last component, root or parent).
+              </para>
+            </listitem>
+          </itemizedlist>
+        </note>
       </section>
     </section>
     <section remap="h3">
index 6cb5c52..90ea731 100644 (file)
     <para>The <literal>pool_name</literal> specifies the OST pool to which the
       file will be written.  This allows limiting the OSTs used to a subset of
       all OSTs in the file system. For more details about using OST pools, see
-      <link xl:href="managingfilesystemio.managing_ost_pools">
-        Creating and Managing OST Pools
-      </link>.</para>
+      <xref linkend="managingfilesystemio.managing_ost_pools" />.</para>
     <section remap="h3">
       <title>Specifying a File Layout (Striping Pattern) for a Single File</title>
       <para>It is possible to specify the file layout when a new file is created using the command <literal>lfs setstripe</literal>. This allows users to override the file system default parameters to tune the file layout more optimally for their application. Execution of an <literal>lfs setstripe</literal> command fails if the file already exists.</para>