Whamcloud - gitweb
LUDOC-11 misc: remove references for older Lustre
[doc/manual.git] / Revision.xml
index 2bd9eb6..4dcade3 100644 (file)
@@ -1,28 +1,54 @@
 <?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 <emphasis role="italic">Lustre Operations Manual 2.x</emphasis> is intended
-        to be relevant for all 2.x releases of the Lustre software. Most of the manual content is
-        relevant to all of the releases. However, any features and content that are added for new
-        versions of the Lustre software are clearly marked with the version in which this
-        functionality is added. Similarly, features that are no longer available are marked with the
-        version in which they were deprecated or removed. <revhistory>
+<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>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 condition="l25">This manual covers a range of Lustre 2.x software
+      releases, currently starting with the 2.5 release.  Features specific
+      to individual releases are identified within the table of contents
+      using a shorthand notation (e.g. this paragraph is tagged as a Lustre
+      2.5 specific feature so that it will be updated when the 2.5-specific
+      tagging is removed), and within the text using a distinct box.
+    </para>
+
+    <note xml:id="whichversion"><title>Which version amd I running?</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 node can be found
+    using the command <literal>lctl get_param version</literal> on any Lustre
+    client or server, for example:
+    <screen>$ lctl get_param version
+version=2.10.5
+</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>2.3</revnumber>
-                <date>November 2012</date>
+                <revnumber>0</revnumber>
+                <date>Built on <?dbtimestamp format="d B Y X"?></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>
+                <revremark>Continuous build of Manual.</revremark>
             </revision>
         </revhistory>
     </para>
 </section>
+<!--
+  vim:expandtab:shiftwidth=2:tabstop=8:
+  -->