Skip to contentSkip to conversation

docs: Add BB_HASHSERVE definition to glossary

PATCH In review Michael Opdenacker 2 participants 2 messages Jun 4, 2021 – Jun 11, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Add BB_HASHSERVE definition to glossary

---
 .../bitbake-user-manual-ref-variables.rst              | 10 ++++++++++
 1 file changed, 10 insertions(+)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +10 -0
index e1b640e2..bfb74c11 100644
@@ -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
Signature · 1 line
2.25.1
#1 lore raw

Hi Michael,

Quoted 10 lines · Michael Opdenacker
---
 .../bitbake-user-manual-ref-variables.rst              | 10 ++++++++++
 1 file changed, 10 insertions(+)
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +0 -0
index e1b640e2..bfb74c11 100644

doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst overview of their function and contents. · line 318

Quoted 6 lines
doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +3 -0
@@ -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