[PATCH 0/7] docs: core-api: Fix stale function names and a broken example

[PATCH 0/7] docs: core-api: Fix stale function names and a broken example

[Karl Mehltretter]

A review of Documentation/core-api turned up a handful of places where
the text names a function that does not exist, or an example command
that cannot work as written.  Each one is a plain typo from the day the
text was written rather than an API rename: for every patch the wrong
name was checked against the tree at the time of the Fixes: commit, and
the correct name exists in current mainline.

The changes are independent of each other and only touch prose and
examples, so each can be applied on its own.

Karl Mehltretter (7):
  docs: cpu_hotplug: Fix multi-instance removal calls
  docs: irq-affinity: Restore grep in example
  docs: dma-attributes: Fix dma_alloc_attrs() name
  docs: swiotlb: Fix maximum mapping size helper
  docs: this_cpu_ops: Fix SRCU helper names
  docs: xarray: Fix xas_try_split() name
  docs: debugobjects: Fix debug_object_init() name

 Documentation/core-api/cpu_hotplug.rst | 4 ++--
 Documentation/core-api/irq/irq-affinity.rst | 2 +-
 Documentation/core-api/dma-attributes.rst | 2 +-
 Documentation/core-api/swiotlb.rst | 2 +-
 Documentation/core-api/this_cpu_ops.rst | 6 +++---
 Documentation/core-api/xarray.rst | 2 +-
 Documentation/core-api/debug-objects.rst | 2 +-
 7 files changed, 10 insertions(+), 10 deletions(-)

base-commit: 26260251022fbc2f248a3d747a9b2b961b18d2d8
-- 
2.53.0

[PATCH 6/7] docs: xarray: Fix xas_try_split() name

[Karl Mehltretter]

The iterative split helper is xas_try_split(), not
xas_try_alloc().

Fixes: 3fec86f8aa8c ("xarray: add xas_try_split() to split a multi-index entry")
Assisted-by: Codex:gpt-5.6-sol
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 Documentation/core-api/xarray.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/core-api/xarray.rst b/Documentation/core-api/xarray.rst
index c6c91cbd0c3ce..3d2b20c05a937 100644
--- a/Documentation/core-api/xarray.rst
+++ b/Documentation/core-api/xarray.rst
@@ -490,7 +490,7 @@ entry at every index to ``NULL`` and dissolve the tie.  A multi-index
 entry can be split into entries occupying smaller ranges by calling
 xas_split_alloc() without the xa_lock held, followed by taking the lock
 and calling xas_split() or calling xas_try_split() with xa_lock. The
-difference between xas_split_alloc()+xas_split() and xas_try_alloc() is
+difference between xas_split_alloc()+xas_split() and xas_try_split() is
 that xas_split_alloc() + xas_split() split the entry from the original
 order to the new order in one shot uniformly, whereas xas_try_split()
 iteratively splits the entry containing the index non-uniformly.
-- 
2.53.0

Re: [PATCH 6/7] docs: xarray: Fix xas_try_split() name

[Zi Yan]

On Sat Aug 22, 2026 at 8:16 AM EDT, Karl Mehltretter wrote:
> The iterative split helper is xas_try_split(), not
> xas_try_alloc().
>
> Fixes: 3fec86f8aa8c ("xarray: add xas_try_split() to split a multi-index entry")
> Assisted-by: Codex:gpt-5.6-sol
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>  Documentation/core-api/xarray.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Thanks.

Reviewed-by: Zi Yan <ziy@nvidia.com>

>
> diff --git a/Documentation/core-api/xarray.rst b/Documentation/core-api/xarray.rst
> index c6c91cbd0c3ce..3d2b20c05a937 100644
> --- a/Documentation/core-api/xarray.rst
> +++ b/Documentation/core-api/xarray.rst
> @@ -490,7 +490,7 @@ entry at every index to ``NULL`` and dissolve the tie.  A multi-index
>  entry can be split into entries occupying smaller ranges by calling
>  xas_split_alloc() without the xa_lock held, followed by taking the lock
>  and calling xas_split() or calling xas_try_split() with xa_lock. The
> -difference between xas_split_alloc()+xas_split() and xas_try_alloc() is
> +difference between xas_split_alloc()+xas_split() and xas_try_split() is
>  that xas_split_alloc() + xas_split() split the entry from the original
>  order to the new order in one shot uniformly, whereas xas_try_split()
>  iteratively splits the entry containing the index non-uniformly.




-- 
Best Regards,
Yan, Zi

Re: [PATCH 6/7] docs: xarray: Fix xas_try_split() name

[Randy Dunlap]

On 8/22/26 5:16 AM, Karl Mehltretter wrote:
> The iterative split helper is xas_try_split(), not
> xas_try_alloc().
> 
> Fixes: 3fec86f8aa8c ("xarray: add xas_try_split() to split a multi-index entry")
> Assisted-by: Codex:gpt-5.6-sol
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/core-api/xarray.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/core-api/xarray.rst b/Documentation/core-api/xarray.rst
> index c6c91cbd0c3ce..3d2b20c05a937 100644
> --- a/Documentation/core-api/xarray.rst
> +++ b/Documentation/core-api/xarray.rst
> @@ -490,7 +490,7 @@ entry at every index to ``NULL`` and dissolve the tie.  A multi-index
>  entry can be split into entries occupying smaller ranges by calling
>  xas_split_alloc() without the xa_lock held, followed by taking the lock
>  and calling xas_split() or calling xas_try_split() with xa_lock. The
> -difference between xas_split_alloc()+xas_split() and xas_try_alloc() is
> +difference between xas_split_alloc()+xas_split() and xas_try_split() is
>  that xas_split_alloc() + xas_split() split the entry from the original
>  order to the new order in one shot uniformly, whereas xas_try_split()
>  iteratively splits the entry containing the index non-uniformly.

-- 
~Randy

Re: [PATCH 0/7] docs: core-api: Fix stale function names and a broken example

[Jonathan Corbet]

Karl Mehltretter <kmehltretter@gmail.com> writes:

> A review of Documentation/core-api turned up a handful of places where
> the text names a function that does not exist, or an example command
> that cannot work as written.  Each one is a plain typo from the day the
> text was written rather than an API rename: for every patch the wrong
> name was checked against the tree at the time of the Fixes: commit, and
> the correct name exists in current mainline.
>
> The changes are independent of each other and only touch prose and
> examples, so each can be applied on its own.
>
> Karl Mehltretter (7):
>   docs: cpu_hotplug: Fix multi-instance removal calls
>   docs: irq-affinity: Restore grep in example
>   docs: dma-attributes: Fix dma_alloc_attrs() name
>   docs: swiotlb: Fix maximum mapping size helper
>   docs: this_cpu_ops: Fix SRCU helper names
>   docs: xarray: Fix xas_try_split() name
>   docs: debugobjects: Fix debug_object_init() name
>
>  Documentation/core-api/cpu_hotplug.rst | 4 ++--
>  Documentation/core-api/irq/irq-affinity.rst | 2 +-
>  Documentation/core-api/dma-attributes.rst | 2 +-
>  Documentation/core-api/swiotlb.rst | 2 +-
>  Documentation/core-api/this_cpu_ops.rst | 6 +++---
>  Documentation/core-api/xarray.rst | 2 +-
>  Documentation/core-api/debug-objects.rst | 2 +-
>  7 files changed, 10 insertions(+), 10 deletions(-)

I've applied the set, thanks.

jon