Skip to content

Commit 01f39c1

Browse files
manfred-colorfutorvalds
authored andcommitted
xarray.h: correct return code documentation 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. Signed-off-by: Manfred Spraul <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Cc: Matthew Wilcox <[email protected]> Link: http://lkml.kernel.org/r/[email protected] Signed-off-by: Linus Torvalds <[email protected]>
1 parent db38d5c commit 01f39c1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/linux/xarray.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ void __xa_clear_mark(struct xarray *, unsigned long index, xa_mark_t);
576576
*
577577
* Context: Any context. Takes and releases the xa_lock while
578578
* disabling softirqs.
579-
* Return: The entry which used to be at this index.
579+
* Return: The old entry at this index or xa_err() if an error happened.
580580
*/
581581
static inline void *xa_store_bh(struct xarray *xa, unsigned long index,
582582
void *entry, gfp_t gfp)
@@ -602,7 +602,7 @@ static inline void *xa_store_bh(struct xarray *xa, unsigned long index,
602602
*
603603
* Context: Process context. Takes and releases the xa_lock while
604604
* disabling interrupts.
605-
* Return: The entry which used to be at this index.
605+
* Return: The old entry at this index or xa_err() if an error happened.
606606
*/
607607
static inline void *xa_store_irq(struct xarray *xa, unsigned long index,
608608
void *entry, gfp_t gfp)

0 commit comments

Comments
 (0)