diff mbox series

idr: fix incorrect documentation of idr_is_empty()

Message ID 20220405082238.1670867-1-amcohen@nvidia.com (mailing list archive)
State New, archived
Headers show
Series idr: fix incorrect documentation of idr_is_empty() | expand

Commit Message

Amit Cohen April 5, 2022, 8:22 a.m. UTC 
The function idr_is_empty() returns true in case that the IDR is empty,
which means that there is no ID which is allocated from this IDR.
Currently, the documentation is incorrect and describes the opposite
situation. Fix it.

Signed-off-by: Amit Cohen <amcohen@nvidia.com>
---
 include/linux/idr.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/linux/idr.h b/include/linux/idr.h
index a0dce14090a9..7834af491d46 100644
--- a/include/linux/idr.h
+++ b/include/linux/idr.h
@@ -155,7 +155,7 @@  static inline void idr_init(struct idr *idr)
  * idr_is_empty() - Are there any IDs allocated?
  * @idr: IDR handle.
  *
- * Return: %true if any IDs have been allocated from this IDR.
+ * Return: %true if there is no ID which is allocated from this IDR.
  */
 static inline bool idr_is_empty(const struct idr *idr)
 {