XArray: Fix split documentation

I wrote the documentation backwards; the new order of the entry is stored
in the xas and the caller passes the old entry.

Reported-by: Zi Yan <ziy@nvidia.com>
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
This commit is contained in:
Matthew Wilcox (Oracle) 2020-10-10 11:17:44 -04:00
parent 17860ccabf
commit 12efebab09

View file

@ -987,7 +987,7 @@ static void node_set_marks(struct xa_node *node, unsigned int offset,
* xas_split_alloc() - Allocate memory for splitting an entry. * xas_split_alloc() - Allocate memory for splitting an entry.
* @xas: XArray operation state. * @xas: XArray operation state.
* @entry: New entry which will be stored in the array. * @entry: New entry which will be stored in the array.
* @order: New entry order. * @order: Current entry order.
* @gfp: Memory allocation flags. * @gfp: Memory allocation flags.
* *
* This function should be called before calling xas_split(). * This function should be called before calling xas_split().
@ -1041,9 +1041,10 @@ EXPORT_SYMBOL_GPL(xas_split_alloc);
* xas_split() - Split a multi-index entry into smaller entries. * xas_split() - Split a multi-index entry into smaller entries.
* @xas: XArray operation state. * @xas: XArray operation state.
* @entry: New entry to store in the array. * @entry: New entry to store in the array.
* @order: New entry order. * @order: Current entry order.
* *
* The value in the entry is copied to all the replacement entries. * The size of the new entries is set in @xas. The value in @entry is
* copied to all the replacement entries.
* *
* Context: Any context. The caller should hold the xa_lock. * Context: Any context. The caller should hold the xa_lock.
*/ */