[PATCH] idr: Fix the kernel-doc for idr_is_empty()

[PATCH] idr: Fix the kernel-doc for idr_is_empty()

[Manivannan Sadhasivam]

idr_is_empty() will return 'true' if IDR is empty and 'false' if any IDs
have been allocated from it. But the kernel-doc says the opposite. Hence,
fix it.

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@oss.qualcomm.com>
---

Btw, I'm not sure if we really need the radix_tree_tagged() check in this
function. It looks redundant to me. But since I'm not too sure about it, I left
it as it is.

 include/linux/idr.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/linux/idr.h b/include/linux/idr.h
index 2267902d29a7..4955cf89e9c7 100644
--- a/include/linux/idr.h
+++ b/include/linux/idr.h
@@ -172,7 +172,9 @@ 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 this IDR is empty, or
+ * * %false if any IDs have been allocated from this IDR.
  */
 static inline bool idr_is_empty(const struct idr *idr)
 {
-- 
2.45.2

Re: [PATCH] idr: Fix the kernel-doc for idr_is_empty()

[Sidhartha Kumar]

On 7/30/25 7:34 AM, Manivannan Sadhasivam wrote:
> idr_is_empty() will return 'true' if IDR is empty and 'false' if any IDs
> have been allocated from it. But the kernel-doc says the opposite. Hence,
> fix it.
> 
> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@oss.qualcomm.com>

Reviewed-by: Sidhartha Kumar <sidhartha.kumar@oracle.com>

> ---
> 
> Btw, I'm not sure if we really need the radix_tree_tagged() check in this
> function. It looks redundant to me. But since I'm not too sure about it, I left
> it as it is.
> 
>   include/linux/idr.h | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/include/linux/idr.h b/include/linux/idr.h
> index 2267902d29a7..4955cf89e9c7 100644
> --- a/include/linux/idr.h
> +++ b/include/linux/idr.h
> @@ -172,7 +172,9 @@ 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 this IDR is empty, or
> + * * %false if any IDs have been allocated from this IDR.
>    */
>   static inline bool idr_is_empty(const struct idr *idr)
>   {