Skip to contentSkip to conversation

xarray.h: Correct return code for xa_store_{bh,irq}()

PATCH Applied Manfred Spraul 1 participant 1 message Apr 30, 2020 Xarray

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 xarray.h: Correct return code for xa_store_{bh,irq}()

__xa_store() and xa_store() document that the functions can fail, and that the return code can be an xa_err() encoded error code.

xa_store_bh() and xa_store_irq() do not document that the functions can fail and that they can also return xa_err() encoded error codes.

Thus: Update the documentation.

---
 include/linux/xarray.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
include/linux/xarray.h +2 -2
index d79b8e3aa08d..2815c4ec89b1 100644
@@ -576,7 +576,7 @@ void __xa_clear_mark(struct xarray *, unsigned long index, xa_mark_t);
  *
  * Context: Any context.  Takes and releases the xa_lock while
  * disabling softirqs.
- * Return: The entry which used to be at this index.
+ * Return: The old entry at this index or xa_err() if an error happened.
  */
 static inline void *xa_store_bh(struct xarray *xa, unsigned long index,
 		void *entry, gfp_t gfp)
@@ -602,7 +602,7 @@ static inline void *xa_store_bh(struct xarray *xa, unsigned long index,
  *
  * Context: Process context.  Takes and releases the xa_lock while
  * disabling interrupts.
- * Return: The entry which used to be at this index.
+ * Return: The old entry at this index or xa_err() if an error happened.
  */
 static inline void *xa_store_irq(struct xarray *xa, unsigned long index,
 		void *entry, gfp_t gfp)
Signature · 1 line
2.26.2