XArray: minor documentation improvements
authorTamir Duberstein <tamird@gmail.com>
Tue, 5 Nov 2024 12:03:42 +0000 (08:03 -0400)
committerAndrew Morton <akpm@linux-foundation.org>
Mon, 13 Jan 2025 04:21:08 +0000 (20:21 -0800)
commiteb7a18ebd6c72c11494215da603474099b4455af
treebc973a7544e4aa00ef7c4402af564774d40d3d70
parent876a5b25d54d2fbc67c3a80abbde097b321f7710
XArray: minor documentation improvements

- Replace "they" with "you" where "you" is used in the preceding
  sentence fragment.
- Mention `xa_erase` in discussion of multi-index entries.  Split this
  into a separate sentence.
- Add "call" parentheses on "xa_store" for consistency and
  linkification.
- Add caveat that `xa_store` and `xa_erase` are not equivalent in the
  presence of `XA_FLAGS_ALLOC`.

Link: https://lkml.kernel.org/r/20241105-xarray-documentation-v5-1-8e1702321b41@gmail.com
Signed-off-by: Tamir Duberstein <tamird@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Matthew Wilcox <willy@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Documentation/core-api/xarray.rst