XArray: document that tags persist after storing new elements

This is a very useful feature, document it.

Signed-off-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260819065714.1358822-1-hch@lst.de>
This commit is contained in:
Christoph Hellwig 2026-08-19 08:57:14 +02:00 committed by Jonathan Corbet
parent 722c814017
commit 4be78eadd1

View File

@ -127,6 +127,8 @@ by using xa_set_mark() and remove the mark from an entry by calling
xa_clear_mark(). You can ask whether any entry in the XArray has a
particular mark set by calling xa_marked(). Erasing an entry from the
XArray causes all marks associated with that entry to be cleared.
Storing a new entry that replaces an existing entry keeps the marks
associated with the index intact.
Setting or clearing a mark on any index of a multi-index entry will
affect all indices covered by that entry. Querying the mark on any