From c7974d194c6d479c537531c1c68c589574b29683 Mon Sep 17 00:00:00 2001 From: "Julian M. Kunkel" Date: Sun, 19 Jan 2020 11:09:49 +0000 Subject: [PATCH] Updated user documentation for changed odirect --- doc/USER_GUIDE | 3 ++- doc/sphinx/userDoc/options.rst | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/USER_GUIDE b/doc/USER_GUIDE index 62a6802..3d6b4e4 100755 --- a/doc/USER_GUIDE +++ b/doc/USER_GUIDE @@ -65,7 +65,6 @@ These options are to be used on the command line. E.g., 'IOR -a POSIX -b 4K'. -a S api -- API for I/O, e.g., POSIX -A N refNum -- user reference number to include in long summary -b N blockSize -- contiguous bytes to write per task (e.g.: 8, 4k, 2m, 1g) - -B useO_DIRECT -- uses O_DIRECT for POSIX, bypassing I/O buffers -c collective -- collective I/O -C reorderTasksConstant -- changes task ordering to n+1 ordering for readback -d N interTestDelay -- delay between reps in seconds @@ -118,6 +117,8 @@ NOTES: * S is a string, N is an integer number. * For transfer and block sizes, the case-insensitive K, M, and G suffices are recognized. I.e., '4k' or '4K' is accepted as 4096. +Various options are only valid for specific modules, you can see details when running $ ./ior -h +These options are typically prefixed with the module name, an example is: --posix.odirect ********************* * 4. OPTION DETAILS * diff --git a/doc/sphinx/userDoc/options.rst b/doc/sphinx/userDoc/options.rst index 86fc97e..31240f0 100644 --- a/doc/sphinx/userDoc/options.rst +++ b/doc/sphinx/userDoc/options.rst @@ -22,7 +22,6 @@ These options are to be used on the command line (e.g., ``./ior -a POSIX -b 4K`` -a S api -- API for I/O [POSIX|MPIIO|HDF5|HDFS|S3|S3_EMC|NCMPI|RADOS] -A N refNum -- user reference number to include in long summary -b N blockSize -- contiguous bytes to write per task (e.g.: 8, 4k, 2m, 1g) - -B useO_DIRECT -- uses O_DIRECT for POSIX, bypassing I/O buffers -c collective -- collective I/O -C reorderTasksConstant -- changes task ordering to n+1 ordering for readback -d N interTestDelay -- delay between reps in seconds @@ -76,6 +75,9 @@ These options are to be used on the command line (e.g., ``./ior -a POSIX -b 4K`` * For transfer and block sizes, the case-insensitive K, M, and G suffices are recognized. I.e., '4k' or '4K' is accepted as 4096. +Various options are only valid for specific modules, you can see details when running $ ./ior -h +These options are typically prefixed with the module name, an example is: --posix.odirect + Directive Options ------------------