doc: update code comments about available timeout options

Adding some code comments to make them readable and easy to understand.

Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
This commit is contained in:
Prasanna Kumar Kalever 2021-08-19 11:53:15 +05:30 committed by mergify[bot]
parent 7576bf400c
commit 3bf17ade7a

View File

@ -48,9 +48,16 @@ const (
rbdUnmapCmdNbdMissingMap = "rbd-nbd: %s is not mapped" rbdUnmapCmdNbdMissingMap = "rbd-nbd: %s is not mapped"
rbdMapConnectionTimeout = "Connection timed out" rbdMapConnectionTimeout = "Connection timed out"
defaultNbdReAttachTimeout = 300 defaultNbdReAttachTimeout = 300 /* in seconds */
// The default way of creating nbd devices via rbd-nbd is through the
// legacy ioctl interface, to take advantage of netlink features we
// should specify `try-netlink` flag explicitly.
useNbdNetlink = "try-netlink" useNbdNetlink = "try-netlink"
// `reattach-timeout` of rbd-nbd is to tweak NBD_ATTR_DEAD_CONN_TIMEOUT.
// It specifies how long the device should be held waiting for the
// userspace process to come back to life.
setNbdReattach = "reattach-timeout" setNbdReattach = "reattach-timeout"
) )