From: Keith Busch <kbusch@kernel.org>
Date: Wed, 10 Jun 2020 18:06:35 +0000 (-0700)
Subject: document corner case for large nsids
X-Git-Tag: v1.0-rc0~143
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=a4582173fe8072f80f5eef7eca77d52f853d81dc;p=users%2Fsagi%2Flibnvme.git

document corner case for large nsids

Signed-off-by: Keith Busch <kbusch@kernel.org>
---

diff --git a/src/nvme/ioctl.h b/src/nvme/ioctl.h
index 6c7b8c25..12edb604 100644
--- a/src/nvme/ioctl.h
+++ b/src/nvme/ioctl.h
@@ -360,7 +360,10 @@ int nvme_ns_rescan(int fd);
  * @fd:		File descriptor of nvme namespace
  * @nsid:	User pointer to namespace id
  *
- * This should only be sent to namespace handles, not to controllers.
+ * This should only be sent to namespace handles, not to controllers. The
+ * kernel's interface returns the nsid as the return value. This is unfortunate
+ * for many architectures that are incapable of allowing distinguishing a
+ * namespace id > 0x80000000 from a negative error number.
  *
  * Return: 0 if @nsid was set succecssfully or -1 with errno set otherwise.
  */