From: Stefan Kooman <stefan@bit.nl>
Date: Thu, 27 Sep 2018 12:11:05 +0000 (+0200)
Subject: doc: add "--timeout" option to rbd-nbd
X-Git-Tag: v14.0.1~151^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=183caeced76f654fcdf47cfbdbd8c011f18f8013;p=ceph.git

doc: add "--timeout" option to rbd-nbd

Fixes: https://tracker.ceph.com/issues/22333
Signed-off-by: Stefan Kooman <stefan@bit.nl>
---

diff --git a/doc/man/8/rbd-nbd.rst b/doc/man/8/rbd-nbd.rst
index bb20a4d1ebca..df278a70d8ba 100644
--- a/doc/man/8/rbd-nbd.rst
+++ b/doc/man/8/rbd-nbd.rst
@@ -9,7 +9,7 @@
 Synopsis
 ========
 
-| **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] map *image-spec* | *snap-spec*
+| **rbd-nbd** [-c conf] [--read-only] [--device *nbd device*] [--nbds_max *limit*] [--max_part *limit*] [--exclusive] [--timeout *seconds*] map *image-spec* | *snap-spec*
 | **rbd-nbd** unmap *nbd device*
 | **rbd-nbd** list-mapped
 
@@ -45,6 +45,11 @@ Options
 
    Forbid writes by other clients.
 
+.. option:: --timeout *seconds*
+
+   Override device timeout. Linux kernel will default to a 30 second request timeout.
+   Allow the user to optionally specify an alternate timeout.
+
 Image and snap specs
 ====================