LUDOC-469 hsm: correct description of NBR HSM policy

[doc/manual.git] / UserUtilities.xml

diff --git a/UserUtilities.xml b/UserUtilities.xml
index b60ba9e..9c19dfa 100644 (file)
--- a/UserUtilities.xml
+++ b/UserUtilities.xml
@@ -22,6 +22,7 @@ lfs
 lfs changelog [--follow] <replaceable>mdt_name</replaceable> [startrec [endrec]]
 lfs changelog_clear <replaceable>mdt_name id endrec</replaceable>
 lfs check <replaceable>mds|osts|servers</replaceable>
+lfs data_version [-nrw] <replaceable>filename</replaceable>
 lfs df [-i] [-h] [--pool]-p <replaceable>fsname</replaceable>[.<replaceable>pool</replaceable>] [<replaceable>path</replaceable>] [--lazy]
 lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
          [[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n <replaceable>pattern</replaceable>]
@@ -37,7 +38,8 @@ lfs getstripe [--obd|-O <replaceable>ost_name</replaceable>] [--quiet|-q] [--ver
               [--mdt-index|-M] [--recursive|-r] [--raw|-R]
               [--layout|-L]
               <replaceable>dirname|filename</replaceable> ...
-lfs setstripe [--size|-s stripe_size] [--count|-c <replaceable>stripe_count</replaceable>]
+lfs setstripe [--size|-s stripe_size] [--stripe-count|-c <replaceable>stripe_count</replaceable>]
+              [--overstripe-count|-C <replaceable>stripe_count</replaceable>]
               [--stripe-index|-i <replaceable>start_ost_index</replaceable>]
               [--ost-list|-o <replaceable>ost_indicies</replaceable>]
               [--pool|-p <replaceable>pool</replaceable>]
@@ -171,6 +173,40 @@ lfs help
             </row>
             <row>
               <entry nameend="c2" namest="c1">
+                <para>
+                  <literal>data_version [-nrw]
+                  <replaceable>filename</replaceable></literal>
+                </para>
+              </entry>
+              <entry>
+               <para>Displays the current version of file data. If
+               <literal>-n</literal> is specified, the data version is read
+               without taking a lock. As a consequence, the data version could
+               be outdated if there are dirty caches on filesystem clients, but
+               this option will not force data flushes and has less of an
+               impact on the filesystem. If <literal>-r</literal> is specified,
+               the data version is read after dirty pages on clients are
+               flushed. If <literal>-w</literal> is specified, the data version
+               is read after all caching pages on clients are flushed.
+               </para>
+               <para>
+               Even with <literal>-r</literal> or <literal>-w</literal>, race
+               conditions are possible and the data version should be checked
+               before and after an operation to be confident the data did not
+               change during it.
+               </para>
+               <para>
+               The  data  version is the sum of the last committed transaction
+               numbers of all data objects of a file. It is used by HSM policy
+               engines for verifying that file data has not been changed during
+               an archive operation or before a release operation, and by OST
+               migration, primarily for verifying that file data has not been
+               changed during a data copy, when done in non-blocking mode.
+               </para>
+              </entry>
+            </row>
+            <row>
+              <entry nameend="c2" namest="c1">
                 <literal>df [-i] [-h] [--pool|-p 
                 <replaceable>fsname</replaceable>[.
                 <replaceable>pool</replaceable>] [
@@ -451,7 +487,7 @@ lfs help
                 <para condition="l24">The 
                 <literal>--mdt-index</literal> prints the index of the MDT for a given
                 directory. See 
-                <xref linkend="dbdoclet.rmremotedir" />.</para>
+                <xref linkend="lustremaint.rmremotedir" />.</para>
               </entry>
             </row>
             <row>
@@ -501,7 +537,7 @@ lfs help
               </entry>
               <entry>
                 <para>
-                  <literal>--count</literal>
+                  <literal>--stripe-count</literal>
                 </para>
               </entry>
               <entry>
@@ -612,7 +648,7 @@ lfs help
               </entry>
               <entry>
                 <para>
-                  <literal>--count stripe_cnt</literal>
+                  <literal>--stripe-count stripe_cnt</literal>
                 </para>
               </entry>
               <entry>
@@ -629,6 +665,24 @@ lfs help
               </entry>
               <entry>
                 <para>
+                  <literal>--overstripe-count stripe_cnt</literal>
+                </para>
+              </entry>
+              <entry>
+                <para>The same as --stripe-count, but allows overstriping,
+                which will place more than one stripe per OST if
+                <literal>stripe_cnt</literal> is greater than the number of
+                OSTs. Overstriping is useful for matching the number of stripes
+                to the number of processes, or with very fast OSTs, where one
+                stripe per OST is not enough to get full performance.</para>
+              </entry>
+            </row>
+            <row>
+              <entry>
+                <para>&#160;</para>
+              </entry>
+              <entry>
+                <para>
                 <literal>--size stripe_size</literal>
                 <footnote>
                   <para>The default stripe-size is 0. The default start-ost is
@@ -1596,7 +1650,7 @@ File size of /mnt/lustre/foo is 1468297786 (1433888 blocks of 1024 bytes)
               </para>
             </entry>
             <entry>
-              <para condition="l23">Enables/disables FID to path translation by
+              <para>Enables/disables FID to path translation by
               regular users</para>
             </entry>
           </row>