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

Karl Mehltretter posted 7 patches 1 month ago
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(-)
[PATCH 0/7] docs: core-api: Fix stale function names and a broken example
Posted by Karl Mehltretter 1 month ago
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
Re: [PATCH 0/7] docs: core-api: Fix stale function names and a broken example
Posted by Jonathan Corbet 3 weeks, 6 days ago
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