Philipp Stanner e7716c74e3 xarray: Document necessary flag in alloc functions
Adds a new line to the docstrings of functions wrapping __xa_alloc() and
__xa_alloc_cyclic(), informing about the necessity of flag XA_FLAGS_ALLOC
being set previously.

The documentation so far says that functions wrapping __xa_alloc() and
__xa_alloc_cyclic() are supposed to return either -ENOMEM or -EBUSY in
case of an error. If the xarray has been initialized without the flag
XA_FLAGS_ALLOC, however, they fail with a different, undocumented error
code.

As hinted at in Documentation/core-api/xarray.rst, wrappers around these
functions should only be invoked when the flag has been set. The
functions' documentation should reflect that as well.

Signed-off-by: Philipp Stanner <pstanner@redhat.com>
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
2023-09-05 19:01:38 -04:00
..
2023-06-13 15:13:20 -07:00
2023-06-09 17:44:13 -07:00
2021-05-06 19:24:12 -07:00
2023-04-08 13:45:37 -07:00
2021-01-21 14:06:00 -07:00
2022-03-07 12:48:35 -07:00
2021-08-19 09:02:55 +09:00
2023-02-02 22:50:01 -08:00
2023-02-02 22:50:01 -08:00
2022-04-22 21:30:57 +02:00
2023-02-15 15:44:43 +01:00
2021-01-03 20:05:18 -05:00
2023-03-19 10:02:04 -07:00
2022-03-07 12:48:35 -07:00
2022-04-29 14:38:01 -07:00
2022-07-10 13:55:49 -07:00
2022-10-03 14:03:21 -07:00
2021-08-19 09:02:55 +09:00
2023-07-08 12:08:39 -07:00
2021-07-08 11:48:20 -07:00
2023-04-17 18:01:23 +02:00
2021-07-08 11:48:20 -07:00
2022-10-03 17:34:32 -07:00
2021-07-08 11:48:20 -07:00
2023-07-21 11:40:20 -06:00
2023-07-06 10:06:04 -07:00
2022-06-03 10:34:34 -07:00
2021-06-18 11:43:09 +02:00
2021-07-08 11:48:20 -07:00
2023-05-31 12:58:38 +02:00
2022-01-20 08:52:54 +02:00
2022-12-13 15:47:48 -08:00