Re: [PATCH v3] arm64: perf: Drop the example the userspace counter section points at

[James Clark <james.clark@linaro.org>]

On 11/11/2026 03:44, TAKANO Mitsuhiro wrote:
> Documentation/arch/arm64/perf.rst points at
> tools/perf/arch/arm64/tests/user-events.c, in the text and in the link
> target, but that file is not in the tree and no commit in the history
> leading to this base has added one.
> 
> The section already describes how to use the libperf helpers and points at
> tools/lib/perf/tests/test-evsel.c as the example, so the sentence that
> sends the reader elsewhere is redundant.  Remove it and the link target
> rather than pointing at another test, and move the instruction for running
> the example into the How-to section, next to the reference it belongs to.
> 
> Signed-off-by: TAKANO Mitsuhiro <takano32@gmail.com>
> ---
> v2: drop the reference instead of pointing it at another file, and move
>      the instruction for running the example into the How-to section.
> v3: the v1 history moves here, so the commit log is the change alone; the
>      sentence about the missing file is stated once.  Raised by Sashiko.
> 
>   Documentation/arch/arm64/perf.rst | 17 ++++++-----------
>   1 file changed, 6 insertions(+), 11 deletions(-)
> 
> diff --git a/Documentation/arch/arm64/perf.rst b/Documentation/arch/arm64/perf.rst
> index 997fd716b82f..5b9cc2aeb642 100644
> --- a/Documentation/arch/arm64/perf.rst
> +++ b/Documentation/arch/arm64/perf.rst
> @@ -131,7 +131,12 @@ changed.
>   
>   The userspace access is supported in libperf using the perf_evsel__mmap()
>   and perf_evsel__read() functions. See `tools/lib/perf/tests/test-evsel.c`_ for
> -an example.
> +an example, which can be built and run from the source tree:
> +
> +.. code-block:: sh
> +
> +  make -C tools/lib/perf make-tests
> +  tools/lib/perf/tests-static
>   
>   About heterogeneous systems
>   ---------------------------
> @@ -140,14 +145,6 @@ only be enabled when the tasks are pinned to a homogeneous subset of cores and
>   the corresponding PMU instance is opened by specifying the 'type' attribute.
>   The use of generic event types is not supported in this case.
>   
> -Have a look at `tools/perf/arch/arm64/tests/user-events.c`_ for an example. It
> -can be run using the perf tool to check that the access to the registers works
> -correctly from userspace:
> -
> -.. code-block:: sh
> -
> -  perf test -v user
> -
>   About chained events and counter sizes
>   --------------------------------------
>   The user can request either a 32-bit (config1:0 == 0) or 64-bit (config1:0 == 1)
> @@ -160,8 +157,6 @@ userspace must treat the upper 32-bits read from the counter as UNKNOWN. The
>   and should be used to mask the upper bits as needed.
>   
>   .. Links
> -.. _tools/perf/arch/arm64/tests/user-events.c:
> -   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/arch/arm64/tests/user-events.c
>   .. _tools/lib/perf/tests/test-evsel.c:
>      https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/lib/perf/tests/test-evsel.c
>   
> 
> base-commit: 7475ea8b58616b33c04afb976cf0fbaad9dd63fb

Reviewed-by: James Clark <james.clark@linaro.org>