• Philipp Stanner's avatar
    xarray: Document necessary flag in alloc functions · e7716c74
    Philipp Stanner authored
    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: default avatarPhilipp Stanner <pstanner@redhat.com>
    Signed-off-by: default avatarMatthew Wilcox (Oracle) <willy@infradead.org>
    e7716c74
xarray.h 57.9 KB