RDMA engine: rewrite header comment block and man page section

Spelling and grammar fixes for the header comment. Also make it clear that
users can choose between the RDMA software provided by their Linux distributor
and OFED. Update a related paragraph in the man page too.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Cc: Ren Yufei <renyufei83@yahoo.com.cn>
Signed-off-by: Jens Axboe <jaxboe@fusionio.com>

diff --git a/engines/rdma.c b/engines/rdma.c
index 61a90b8a6dd9a6d912f993cc47c42bcc2e5e0e39..fa94865f6284c7e6ff9117e41237937bb387b37c 100644 (file)
--- a/engines/rdma.c
+++ b/engines/rdma.c
@@ -1,16 +1,17 @@
 /*
 /*

- * rdma engine
+ * RDMA I/O engine

  *
  *

- * RDMA IO engine using OFED library.
- * Support both RDMA memory semantic and channel semantic
- *   in InfiniBand, RoCE and iWarp environment.
+ * RDMA I/O engine based on the IB verbs and RDMA/CM user space libraries.
+ * Supports both RDMA memory semantics and channel semantics
+ *   for the InfiniBand, RoCE and iWARP protocols.

  *
  *

- * This is currently disabled. To enable it, execute:
+ * This I/O engine is disabled by default. To enable it, execute:

  *
  * $ export EXTFLAGS="-DFIO_HAVE_RDMA"
  * $ export EXTLIBS="-libverbs -lrdmacm"
  *
  *
  * $ export EXTFLAGS="-DFIO_HAVE_RDMA"
  * $ export EXTLIBS="-libverbs -lrdmacm"
  *

- * before running make. You'll need the OFED as well:
+ * before running make. You will need the Linux RDMA software as well, either
+ * from your Linux distributor or directly from openfabrics.org:

  *
  * http://www.openfabrics.org/downloads/OFED/
  *
  *
  * http://www.openfabrics.org/downloads/OFED/
  *

diff --git a/fio.1 b/fio.1
index 65877d2001b5ab8d743e524699a33cacf6ff7f5e..21ccda5e7917cbe1db59a76a5b2af9705a097103 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -411,8 +411,8 @@ approach to asycnronous I/O.
 See <http://www.xmailserver.org/guasi\-lib.html>.
 .TP
 .B rdma
 See <http://www.xmailserver.org/guasi\-lib.html>.
 .TP
 .B rdma

-The RDMA I/O engine supports both RDMA memory semantic(RDMA_WRITE/RDMA_READ)
-and channel semantic(Send/Recv) in InfiniBand, RoCE and iWarp environment.
+The RDMA I/O engine supports both RDMA memory semantics (RDMA_WRITE/RDMA_READ)
+and channel semantics (Send/Recv) for the InfiniBand, RoCE and iWARP protocols.

 .TP
 .B external
 Loads an external I/O engine object file.  Append the engine filename as
 .TP
 .B external
 Loads an external I/O engine object file.  Append the engine filename as