diff mbox series

docs: brief-yoctoprojectqs: explicit version dependency on websockets python module

Message ID 20240503-websockets-module-v1-1-4065c348276d@cherry.de
State New
Headers show
Series docs: brief-yoctoprojectqs: explicit version dependency on websockets python module | expand

Commit Message

Quentin Schulz May 3, 2024, 5:07 p.m. UTC
From: Quentin Schulz <quentin.schulz@cherry.de>

We now check that the websockets module version is at least 9.1 in
bitbake itself so we can specify more precisely what "recent version"
means.

While at it, list which distributions have a recent enough websockets
python module in their package feed and give some hint at how to support
other distributions.

Cc: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
This is done according to the pending patch:
https://lore.kernel.org/bitbake-devel/20240502183516.1216885-1-JPEWhacker@gmail.com/T/#u

Still wondering if we should add this to poky.yaml.in as a "hard"
dependency? If we do, how do we plan to handle distros which do not have
(a recent enough) websockets python module?
---
 documentation/brief-yoctoprojectqs/index.rst | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)


---
base-commit: 291dae69b7ecc5ae49f378a7098c1187c820765b
change-id: 20240503-websockets-module-d6fba12a4171

Best regards,

Comments

Richard Purdie May 9, 2024, 10:59 a.m. UTC | #1
On Fri, 2024-05-03 at 19:07 +0200, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@cherry.de>
> 
> We now check that the websockets module version is at least 9.1 in
> bitbake itself so we can specify more precisely what "recent version"
> means.
> 
> While at it, list which distributions have a recent enough websockets
> python module in their package feed and give some hint at how to
> support
> other distributions.
> 
> Cc: Quentin Schulz <foss+yocto@0leil.net>
> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
> ---
> This is done according to the pending patch:
> https://lore.kernel.org/bitbake-devel/20240502183516.1216885-1-JPEWhacker@gmail.com/T/#u
> 
> Still wondering if we should add this to poky.yaml.in as a "hard"
> dependency? If we do, how do we plan to handle distros which do not
> have (a recent enough) websockets python module?

It isn't a hard dependency since you could just not use the hash
equivalence server.

I have just queued a patch to bitbake to clarify that with python 3.10,
you need websockets 10.0.

I also merged this to the master/scathgap branches since some info is
better than none. Steve should be able to get that into 5.0.1.

Cheers,

Richard
Quentin Schulz May 13, 2024, 8:02 a.m. UTC | #2
Hi Richard, Michael,

On 5/9/24 12:59 PM, Richard Purdie wrote:
> On Fri, 2024-05-03 at 19:07 +0200, Quentin Schulz wrote:
>> From: Quentin Schulz <quentin.schulz@cherry.de>
>>
>> We now check that the websockets module version is at least 9.1 in
>> bitbake itself so we can specify more precisely what "recent version"
>> means.
>>
>> While at it, list which distributions have a recent enough websockets
>> python module in their package feed and give some hint at how to
>> support
>> other distributions.
>>
>> Cc: Quentin Schulz <foss+yocto@0leil.net>
>> Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
>> ---
>> This is done according to the pending patch:
>> https://lore.kernel.org/bitbake-devel/20240502183516.1216885-1-JPEWhacker@gmail.com/T/#u
>>
>> Still wondering if we should add this to poky.yaml.in as a "hard"
>> dependency? If we do, how do we plan to handle distros which do not
>> have (a recent enough) websockets python module?
> 
> It isn't a hard dependency since you could just not use the hash
> equivalence server.
> 

OK. We could document it the same way and in the same place as we do for 
the docs:

https://docs.yoctoproject.org/ref-manual/system-requirements.html#required-packages-for-the-build-host

"""
Here are the packages needed to build Project documentation manuals:
"""

and do the same for the hashequiv server?

Just looking for how to handle this best :)

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 4301bfd97..c5400e4ac 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -256,8 +256,11 @@  an entire Linux distribution, including the toolchain, from source.
          BB_HASHSERVE = "auto"
          BB_SIGNATURE_HANDLER = "OEEquivHash"
 
-      The hash equivalence server needs a recent version of python
-      websockets installed to work correctly.
+      The hash equivalence server needs the websockets python module version 9.1
+      or later. Debian GNU/Linux 12 (Bookworm) and later, Fedora, CentOS Stream
+      9 and later, and Ubuntu 22.04 (LTS) and later, all have a recent enough
+      package. Other supported distributions need to get the module some other
+      place than their package feed, e.g. via ``pip``.
 
 #. **Start the Build:** Continue with the following command to build an OS
    image for the target, which is ``core-image-sato`` in this example: