diff mbox series

ref-manual/structure.rst: extend PERSISTENT_DIR description

Message ID 20250915-improve-persistent-dir-v1-1-ba42b490453e@bootlin.com
State New
Headers show
Series ref-manual/structure.rst: extend PERSISTENT_DIR description | expand

Commit Message

Antonin Godard Sept. 15, 2025, 12:26 p.m. UTC 
Extend the description of PERSISTENT_DIR to mention that it should not
be shared between builds. Add a note on sharing the hash equivalence
database by setting up a server and not sharing the file in this
directory.

[YOCTO #15727]

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


---
base-commit: dbc6137cd13f982a7fd4d1b2df79dccb177db0fc
change-id: 20250914-improve-persistent-dir-e8eac0abe0b0

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

Patch

diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index c9c44bc63..660cc9be1 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -253,6 +253,17 @@  It also contains ``sanity_info``, a text file keeping track of important
 build information such as the values of :term:`TMPDIR`, :term:`SSTATE_DIR`,
 as well as the name and version of the host distribution.
 
+This directory should not be shared between builds.
+
+.. note::
+
+   The default location of the :ref:`overview-manual/concepts:Hash Equivalence`
+   database is this directory (when :term:`BB_HASHSERVE` is set to ``auto``). If
+   you need to share the :ref:`overview-manual/concepts:Hash Equivalence`
+   database, don't share this file and instead refer to the
+   :doc:`/dev-manual/hashequivserver` document of the Yocto Project Development
+   Tasks Manual to setup Hash Equivalence server.
+
 .. _structure-build-conf-local.conf:
 
 ``build/conf/local.conf``