diff mbox series

[yocto-docs,v2,07/14] ref-manual/classes: document the cython class

Message ID 20241220-release-note-5-2-updates-v2-7-df29527f3fc5@bootlin.com
State Accepted
Headers show
Series Updates from recent core changes | expand

Commit Message

Antonin Godard Dec. 20, 2024, 12:16 p.m. UTC
Small class added in oecore by commit
64b6e8580842949be58f97f4dff91d1f097c4020 ("classes-recipe: add cython
class").

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

Comments

Quentin Schulz Jan. 14, 2025, 10:37 a.m. UTC | #1
Hi Antonin,

On 12/20/24 1:16 PM, Antonin Godard wrote:
> Small class added in oecore by commit
> 64b6e8580842949be58f97f4dff91d1f097c4020 ("classes-recipe: add cython
> class").
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>

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

For your information, I have an alias to only keep the 12 first digits 
of a commit (which is what's used in the Linux kernel for the Fixes: tag).

alias gitf="git --no-pager log --abbrev=12 -1 --pretty='%h (\"%s\")'"

You then simply call gitf 64b6e8580842949be58f97f4dff91d1f097c4020 and 
you'd get
64b6e8580842 ("classes-recipe: add cython class")

This also highlights that this commit is not in OE-Core but in Poky :) 
(they do not have the same commit id).

Cheers,
Quentin
Antonin Godard Jan. 17, 2025, 1:48 p.m. UTC | #2
Hi Quentin,

On Tue Jan 14, 2025 at 11:37 AM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 12/20/24 1:16 PM, Antonin Godard wrote:
>> Small class added in oecore by commit
>> 64b6e8580842949be58f97f4dff91d1f097c4020 ("classes-recipe: add cython
>> class").
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> For your information, I have an alias to only keep the 12 first digits 
> of a commit (which is what's used in the Linux kernel for the Fixes: tag).
>
> alias gitf="git --no-pager log --abbrev=12 -1 --pretty='%h (\"%s\")'"
>
> You then simply call gitf 64b6e8580842949be58f97f4dff91d1f097c4020 and 
> you'd get
> 64b6e8580842 ("classes-recipe: add cython class")

Thanks, added to my shell rc :)

> This also highlights that this commit is not in OE-Core but in Poky :) 
> (they do not have the same commit id).
>
> Cheers,
> Quentin


Antonin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 3d61d8d7a00b21fcff82a771f9718013fae36694..af9aac928186f6a545d9899a24bd9e3dc80ef2e8 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -614,6 +614,15 @@  You will find some more details in the
 ":ref:`dev-manual/vulnerabilities:checking for vulnerabilities`"
 section in the Development Tasks Manual.
 
+.. _ref-classes-cython:
+
+``cython``
+==========
+
+The :ref:`ref-classes-cython` class can be used by Python recipes that require
+`Cython <https://cython.org/>`__ as part of their build dependencies
+(:term:`DEPENDS`).
+
 .. _ref-classes-debian:
 
 ``debian``