Commit f1c2bca2 authored by Christoph Hellwig's avatar Christoph Hellwig Committed by Andrew Morton
Browse files

xarray: fix kerneldoc for __xa_cmpxchg 

Fix the documentation for __xa_cmpxchg to actually describe the
cmpxch-like semantics correctly, based on the version for xa_cmpxchg.

Link: https://lkml.kernel.org/r/20250507051656.3900864-1-hch@lst.de


Signed-off-by: default avatarChristoph Hellwig <hch@lst.de>
Cc: Matthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 5ec56c1c

lib/xarray.c

+6 −3
Original line number Diff line number Diff line
@@ -1742,20 +1742,23 @@ static inline void *__xa_cmpxchg_raw(struct xarray *xa, unsigned long index, 
			void *old, void *entry, gfp_t gfp);



/**

 * __xa_cmpxchg() - Store this entry in the XArray.

 * __xa_cmpxchg() - Conditionally replace an entry in the XArray.

 * @xa: XArray.

 * @index: Index into array.

 * @old: Old value to test against.

 * @entry: New entry.

 * @entry: New value to place in array.

 * @gfp: Memory allocation flags.

 *

 * You must already be holding the xa_lock when calling this function.

 * It will drop the lock if needed to allocate memory, and then reacquire

 * it afterwards.

 *

 * If the entry at @index is the same as @old, replace it with @entry.

 * If the return value is equal to @old, then the exchange was successful.

 *

 * Context: Any context.  Expects xa_lock to be held on entry.  May

 * release and reacquire xa_lock if @gfp flags permit.

 * Return: The old entry at this index or xa_err() if an error happened.

 * Return: The old value at this index or xa_err() if an error happened.

 */

void *__xa_cmpxchg(struct xarray *xa, unsigned long index,

			void *old, void *entry, gfp_t gfp)