[PATCH] dev-manual/start.rst: remove basic setup for hash equivalence

[PATCH] dev-manual/start.rst: remove basic setup for hash equivalence

[Antonin Godard]

Quoting Alexander Kanavin [1]:

> 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a
> server, they set up the hash equivalence client built into bitbake.
>
> 2. The above client configuration (used by poky) also starts a private
> server that is specific to a particular build directory. So hash equiv
> information would not be shared between multiple build directories,
> and this will cause sstate mismatches (as reported in the bug), if
> sstate is shared.

This setup does not shed light on the potential of the hash equivalence
feature. So for now, remove this basic setup, and later rework the
concepts (or create a new) document that explains how to set up a hash
equivalence server shared between builds.

[1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com

Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/start.rst | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index e10367752..f34f0a9a9 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -228,12 +228,7 @@ particular working environment and set of practices.
        used by developers in the same organization and share the same
        source directories on their machines.
 
-    -  Set up a local :ref:`overview-manual/concepts:Hash Equivalence` server
-       with :term:`BB_HASHSERVE` and :term:`BB_SIGNATURE_HANDLER`. A basic setup
-       would be::
-
-          BB_HASHSERVE = "auto"
-          BB_SIGNATURE_HANDLER = "OEEquivHash"
+    -  Set up a local :ref:`overview-manual/concepts :Hash Equivalence` server.
 
        See the :ref:`overview-manual/concepts:Hash Equivalence` section of the
        Yocto Project Overview and Concepts Manual for more details on the hash

---
base-commit: f9f1c87424d307d2df60024bc448bd6778605cf8
change-id: 20250716-remove-local-hashequiv-setup-6c2880dc23fa

Best regards,
--  
Antonin Godard <antonin.godard@bootlin.com>

Re: [PATCH] dev-manual/start.rst: remove basic setup for hash equivalence

[Alexander Kanavin]

Thanks, I think we're good now :)

Alex

On Wed, 16 Jul 2025 at 11:10, Antonin Godard <antonin.godard@bootlin.com> wrote:
>
> Quoting Alexander Kanavin [1]:
>
> > 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a
> > server, they set up the hash equivalence client built into bitbake.
> >
> > 2. The above client configuration (used by poky) also starts a private
> > server that is specific to a particular build directory. So hash equiv
> > information would not be shared between multiple build directories,
> > and this will cause sstate mismatches (as reported in the bug), if
> > sstate is shared.
>
> This setup does not shed light on the potential of the hash equivalence
> feature. So for now, remove this basic setup, and later rework the
> concepts (or create a new) document that explains how to set up a hash
> equivalence server shared between builds.
>
> [1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com
>
> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>  documentation/dev-manual/start.rst | 7 +------
>  1 file changed, 1 insertion(+), 6 deletions(-)
>
> diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
> index e10367752..f34f0a9a9 100644
> --- a/documentation/dev-manual/start.rst
> +++ b/documentation/dev-manual/start.rst
> @@ -228,12 +228,7 @@ particular working environment and set of practices.
>         used by developers in the same organization and share the same
>         source directories on their machines.
>
> -    -  Set up a local :ref:`overview-manual/concepts:Hash Equivalence` server
> -       with :term:`BB_HASHSERVE` and :term:`BB_SIGNATURE_HANDLER`. A basic setup
> -       would be::
> -
> -          BB_HASHSERVE = "auto"
> -          BB_SIGNATURE_HANDLER = "OEEquivHash"
> +    -  Set up a local :ref:`overview-manual/concepts :Hash Equivalence` server.
>
>         See the :ref:`overview-manual/concepts:Hash Equivalence` section of the
>         Yocto Project Overview and Concepts Manual for more details on the hash
>
> ---
> base-commit: f9f1c87424d307d2df60024bc448bd6778605cf8
> change-id: 20250716-remove-local-hashequiv-setup-6c2880dc23fa
>
> Best regards,
> --
> Antonin Godard <antonin.godard@bootlin.com>
>