diff mbox series

bitbake-user-manual/ref-variables: extend PERSISTENT_DIR doc

Message ID 20250915-improve-persistent-dir-v1-1-c0f64b6c5b74@bootlin.com
State New
Headers show
Series bitbake-user-manual/ref-variables: extend PERSISTENT_DIR doc | expand

Commit Message

Antonin Godard Sept. 15, 2025, 12:28 p.m. UTC
Extend the current documentation of PERSISTENT_DIR:

- Mention that it also contains the hash equivalence database when
  BB_HASHSERVE = auto.
- Mention that it should not be shared between builds.

[YOCTO #15727]

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)


---
base-commit: 546b347b4d3d82c01ecc99f45296f66e44638adc
change-id: 20250914-improve-persistent-dir-8d77f6da418f

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

Patch

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 810f886897..3b8fab52e8 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1313,8 +1313,13 @@  overview of their function and contents.
    :term:`PERSISTENT_DIR`
       Specifies the directory BitBake uses to store data that should be
       preserved between builds. In particular, the data stored is the data
-      that uses BitBake's persistent data API and the data used by the PR
-      Server and PR Service.
+      that uses BitBake's persistent data API, the data used by the PR
+      Server and PR Service, and the default location of the Hash Equivalence
+      database (when :term:`BB_HASHSERVE` is set to ``auto``).
+
+      This directory should not be shared between different builds. If you need
+      to share the Hash Equivalence database, you should setup a Hash
+      Equivalence server instead.
 
    :term:`PF`
       Specifies the recipe or package name and includes all version and