From d0c86c50f8cda821a3b3f1e6942c363287627dc0 Mon Sep 17 00:00:00 2001
From: Etienne AUJAMES <etienne.aujames@cea.fr>
Date: Mon, 16 Oct 2023 17:08:40 +0200
Subject: [PATCH] LUDOC-511 pool: reserved poolname "inherit" and "ignore"

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      | 21 +++++++++++++++++++++
 ManagingStripingFreeSpace.xml |  4 +---
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/ManagingFileSystemIO.xml b/ManagingFileSystemIO.xml
index 4c75acb..f4651cb 100644
--- a/ManagingFileSystemIO.xml
+++ b/ManagingFileSystemIO.xml
@@ -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">
diff --git a/ManagingStripingFreeSpace.xml b/ManagingStripingFreeSpace.xml
index 6cb5c52..90ea731 100644
--- a/ManagingStripingFreeSpace.xml
+++ b/ManagingStripingFreeSpace.xml
@@ -252,9 +252,7 @@
     <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>
-- 
1.8.3.1