[PATCH] docs: Add BB_HASHSERVE definition to glossary

[PATCH] docs: Add BB_HASHSERVE definition to glossary

[Michael Opdenacker]

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 .../bitbake-user-manual-ref-variables.rst              | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index e1b640e2..bfb74c11 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -313,6 +313,16 @@ overview of their function and contents.
       However, the more accurate the data returned, the more efficient the
       build will be.
 
+   :term:`BB_HASHSERVE`
+      Specifies the Hash Equivalence server to use.
+
+      If set to ``auto``, BitBake automatically starts its own server
+      over a UNIX domain socket.
+
+      If set to ``host:port``, BitBake will use a remote server on the
+      specified host. This allows multiple clients to share the same
+      hash equivalence data.
+
    :term:`BB_INVALIDCONF`
       Used in combination with the ``ConfigParsed`` event to trigger
       re-parsing the base metadata (i.e. all the recipes). The
-- 
2.25.1

Re: [docs] [PATCH] docs: Add BB_HASHSERVE definition to glossary

[Quentin Schulz]

Hi Michael,

On Fri, Jun 04, 2021 at 06:26:47PM +0200, Michael Opdenacker wrote:
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  .../bitbake-user-manual-ref-variables.rst              | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> index e1b640e2..bfb74c11 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
> @@ -313,6 +313,16 @@ overview of their function and contents.
>        However, the more accurate the data returned, the more efficient the
>        build will be.
>  
> +   :term:`BB_HASHSERVE`
> +      Specifies the Hash Equivalence server to use.
> +

I've never used the Hash Equivalence server before (we're using a release
that does not support it) so I might have missed the documentation for
it... but.. is there actual documentation of what the hash equivalence
server is and what is used for?

I could see a reference to such an explicit definition in some other
page, e.g. https://docs.yoctoproject.org/overview-manual/concepts.html.
(don;t know where it would make sense in bitbake docs since sstate-cache
isn't even explained there yet?).

Also, we'll need to extend
https://docs.yoctoproject.org/overview-manual/yp-intro.html?highlight=sstate#features
"Supports partial builds" with reference to hashserv too.
Probably some other places where sstate-cache is mentioned.

I've nothing to say on the patch itself though :)

Cheers,
Quentin