[PATCH 03/14] XArray: docs: add missing kernel-doc parameters for xas_split_alloc()

Mauro Carvalho Chehab
2020-09-10T10:25:20Z

The parameters for such function are not described. Copy the
description from the conventions (at the beginning of this
file), and fill in the blanks for the @order parameter.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
lib/xarray.c | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/lib/xarray.c b/lib/xarray.c
index c2ae180bd57f..b2dea0c63dbb 100644
--- a/lib/xarray.c
+++ b/lib/xarray.c
@@ -1004,8 +1004,15 @@ static void node_set_marks(struct xa_node *node, unsigned int offset,
}

/**
- * Allocate memory for splitting an entry of @order size into the order
- * stored in the @xas.
+ * xas_split_alloc() - Allocate memory for splitting an entry of
+ * @order size into the order stored in the @xas.
+ *
+ * @xas: is the 'xarray operation state'. It may be either a pointer to
+ * an xa_state, or an xa_state stored on the stack. This is an unfortunate
+ * ambiguity.
+ * @entry: refers to something stored in a slot in the xarray
+ * @order: size of each entry
+ * @gfp: GFP allocation flags
*/
void xas_split_alloc(struct xa_state *xas, void *entry, unsigned int order,
gfp_t gfp)
--
2.26.2