diff mbox series

[v2,13/16] ref-manual/features.rst: add entry for the coresight machine feature

Message ID 20251024-release-note-5-3-second-hunk-v2-13-d15dabc095d0@bootlin.com
State Under Review
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 24, 2025, 8:20 a.m. UTC
Added by commit c455bd039104 ("perf: enable coresight if enabled in
MACHINE_FEATURES") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/features.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Quentin Schulz Oct. 24, 2025, 3:43 p.m. UTC | #1
Hi Antonin,

On 10/24/25 10:20 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Added by commit c455bd039104 ("perf: enable coresight if enabled in
> MACHINE_FEATURES") in OE-Core.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/features.rst | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
> index b295ab44e..6bed23abe 100644
> --- a/documentation/ref-manual/features.rst
> +++ b/documentation/ref-manual/features.rst
> @@ -54,6 +54,11 @@ Project metadata:
>   
>   -  *bluetooth:* Hardware has integrated BT
>   
> +-  *coresight*: Support for the `Coresight

colon should be before the asterisk (that is ":*" instead of "*:" to 
match the other items in the list).

> +   <https://docs.kernel.org/trace/coresight/coresight.html>`__ Linux Kernel
> +   feature on Arm processors. This feature depends on the ``opencsd`` recipe
> +   which is present in the :yocto_git:`meta-arm </meta-arm>` :term:`layer`.
> +

I think this is a mistake, we (oe-core/poky) shouldn't "depend" on 
features defined in other layers. (The PACKAGECONFIG is fine, not the 
filtering on MACHINE_FEATURES). But eh, it's merged so we need to 
document it :)

With the small typo fix above,

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index b295ab44e..6bed23abe 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -54,6 +54,11 @@  Project metadata:
 
 -  *bluetooth:* Hardware has integrated BT
 
+-  *coresight*: Support for the `Coresight
+   <https://docs.kernel.org/trace/coresight/coresight.html>`__ Linux Kernel
+   feature on Arm processors. This feature depends on the ``opencsd`` recipe
+   which is present in the :yocto_git:`meta-arm </meta-arm>` :term:`layer`.
+
 -  *efi:* Support for booting through EFI
 
 -  *ext2:* Hardware HDD or Microdrive