Skip to contentSkip to conversation

XArray: document that tags persist after storing new elements

PATCH Applied Christoph Hellwig 2 participants 2 messages Aug 19 – Aug 31

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 XArray: document that tags persist after storing new elements

This is a very useful feature, document it.

---
 Documentation/core-api/xarray.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/core-api/xarray.rst +2 -0
index c6c91cbd0c3c..9a0d930a8c79 100644
@@ -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
Signature · 1 line
2.53.0
maintainer Applied
#1 lore raw
Quoted 12 lines · Christoph Hellwig

This is a very useful feature, document it.

---
 Documentation/core-api/xarray.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/core-api/xarray.rst +0 -0
index c6c91cbd0c3c..9a0d930a8c79 100644

Documentation/core-api/xarray.rst by using xa_set_mark() and remove the mark from an entry by calling · line 132

Quoted 6 lines
Documentation/core-api/xarray.rst +2 -0
@@ -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.
 

Applied, thanks.

jon