Re: [PATCH v3] XArray: minor documentation improvements

[Randy Dunlap]

Hi Tamir,

On 10/10/24 7:12 AM, Tamir Duberstein wrote:
>  Normal API
>  ==========
> @@ -63,13 +64,14 @@ for statically allocated XArrays or xa_init() for dynamically
>  allocated ones.  A freshly-initialised XArray contains a ``NULL``
>  pointer at every index.
>  
> -You can then set entries using xa_store() and get entries
> -using xa_load().  xa_store will overwrite any entry with the
> -new entry and return the previous entry stored at that index.  You can
> -use xa_erase() instead of calling xa_store() with a
> +You can then set entries using xa_store() and get entries using
> +xa_load().  xa_store() will overwrite any entry with the new entry and
> +return the previous entry stored at that index.  You can unset entries
> +using xa_erase() or by setting the entry to ``NULL`` using xa_store().
>  ``NULL`` entry.  There is no difference between an entry that has never

Is the line above supposed to be here?
Confusing to me.
Thanks.

> -been stored to, one that has been erased and one that has most recently
> -had ``NULL`` stored to it.
> +been stored to and one that has been erased with xa_erase(); an entry
> +that has most recently had ``NULL`` stored to it is also equivalent
> +except if the XArray was initialized with ``XA_FLAGS_ALLOC``.

-- 
~Randy