LUDOC-11 osc: document tunable parameters

[doc/manual.git] / Revision.xml

diff --git a/Revision.xml b/Revision.xml
index 9067f79..7c1edf3 100644 (file)
--- a/Revision.xml
+++ b/Revision.xml
@@ -1,27 +1,52 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <section xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US">
     <title>Revisions</title>
-    <para>
-    Note that the Lustre 2.x manual is intended to be relevant for all 2.x
-    releases of Lustre.  Most of the manual content is relevant to all of
-    the releases.  However, any features and content that are added for new
-    versions of Lustre should be clearly marked with the version in which
-    this functionality is added.  Similarly, features that are no longer
-    available in Lustre 2.x should be marked with the version in which they
-    are deprecated or removed.
-    <revhistory>
-    <revision>
-        <revnumber>2.3</revnumber>
-        <date>November 2012</date>
-        <author><orgname>Intel Corporation</orgname></author>
-        <revremark>Release of Lustre 2.3 manual</revremark>
-    </revision>
-    <revision>
-        <revnumber>2.1</revnumber>
-        <date>June 2011</date>
-        <author><orgname>Whamcloud, Inc</orgname></author>
-        <revremark>First release of Lustre 2.1 manual</revremark>
-    </revision>
-    </revhistory>
+       <para>The Lustre* File System Release 2.x Operations Manual is a community
+maintained work. Versions of the manual are continually built as suggestions for
+changes and improvements arrive. Suggestions for improvements can be submitted
+through the ticketing system maintained at <link
+xl:href="https://jira.whamcloud.com/browse/LUDOC">https://jira.whamcloud.com/browse/LUDOC</link>.
+Instructions for providing a patch to the existing manual are available at:
+<link
+xl:href="http://wiki.lustre.org/Lustre_Manual_Changes">http://wiki.lustre.org/Lustre_Manual_Changes</link>.</para>
+
+       <para>This manual currently covers all the 2.x Lustre software releases.
+Features that are specific to individual releases are identified within the
+table of contents using a short hand notation (i.e. 'L24' is a Lustre software
+release 2.4 specific feature), and within the text using a distinct box.  For
+example:</para>
+
+       <para condition='l24'>Lustre software release version 2.4 includes support
+for multiple metadata servers.</para>
+
+    <note xml:id="whichversion"><title>which version?</title>
+    <indexterm><primary>version</primary>
+    <secondary>which version of Lustre am I running?</secondary></indexterm>
+
+    <para>The current version of Lustre
+    that is in use on the client can be found using the command 
+    <literal>lctl get_param version</literal>, for example:
+    <screen>$ lctl get_param version
+version=
+lustre: 2.7.59
+kernel: patchless_client
+build:  v2_7_59_0-g703195a-CHANGED-3.10.0.lustreopa</screen>
+       </para></note>
+               
+       <para>Only the latest revision of this document is made readily available
+because changes are continually arriving. The current and latest revision of
+this manual is available from links maintained at: <link
+xl:href="http://lustre.opensfs.org/documentation/">http://lustre.opensfs.org/documentation/</link>.
+
+        <revhistory>
+            <revision>
+                <revnumber>0</revnumber>
+                <date>Built on <?dbtimestamp format="d B Y X"?></date>
+                <author>
+                    <orgname>Intel Corporation</orgname>
+                </author>
+                <revremark>Continuous build of Manual.</revremark>
+            </revision>
+        </revhistory>
     </para>
 </section>