LU-17662 osd-zfs: Support for ZFS 2.2.3

[fs/lustre-release.git] / README

diff --git a/README b/README
index 8c862c2..bf0cb99 100644 (file)
--- a/README
+++ b/README
@@ -12,15 +12,23 @@ Lustre is purpose-built to provide a coherent, global POSIX-compliant
 namespace for very large scale computer clusters, including the world's
 largest supercomputer platforms.
 
-It can support hundreds of petabytes of data storage and hundreds of
-gigabytes per second in simultaneous, aggregate throughput.
+It can support hundreds of petabytes of data storage and terabytes per
+second in simultaneous, aggregate throughput.
 
++---------------+
+| Documentation |
++---------------+
 
 More information about Lustre:
     http://www.lustre.org/
 Many resources for using, configuring, and troubleshooting Lustre are at:
     http://wiki.lustre.org/
 
+For in-tree documentation, see the following directories:
+    Documentation/
+    lustre/doc/
+    lnet/doc/
+
 +-----------+
 | Community |
 +-----------+
@@ -38,9 +46,9 @@ To report bugs, please visit:
 The official repository is hosted at:
     https://git.whamcloud.com/
 
-+----------------------+
-| Building and Testing |
-+----------------------+
++----------+
+| Building |
++----------+
 
 Detailed instructions for building, configuring and running Lustre:
     http://wiki.lustre.org/Compiling_Lustre
@@ -54,14 +62,39 @@ To build Lustre:
     ./configure
     make
 
+To see all available make targets:
+
+    make help
+
++---------+
+| Testing |
++---------+
+
+Explanation of Lustre test suites:
+    https://wiki.lustre.org/Test_Descriptions
+and Lustre test environment variables:
+    https://wiki.whamcloud.com/display/PUB/Lustre+Test+Tools+Environment+Variables
+
+
 To play with a test Lustre filesystem:
 
     ./lustre/tests/llmount.sh
 
+To run a test on the filesystem:
+
+    ./lustre/tests/auster -v sanity --only 1
+
 To clean up:
 
     ./lustre/tests/llmountcleanup.sh
 
+To run LUTF (LNet Unit Test Framework) in a Python virtual environment:
+
+    python3 -m venv venv
+    source venv/bin/activate
+    pip3 install -r requirements.txt
+    ./lustre/tests/lutf.sh
+
 +--------------+
 | Contributing |
 +--------------+