diff mbox series

[01/20] ref-manual/fragments.rst: document core/yocto/monitor-disk-space

Message ID 20260918-releases-notes-6-1-v1-1-2d0fceffa242@bootlin.com
State New
Headers show
Series Updates and release notes for 6.1 | expand

Commit Message

Antonin Godard Sept. 18, 2026, 1:53 p.m. UTC
Added by commit df3cc9f85f99
("meta/conf/fragments/yocto/monitor-disk-space.conf: add fragment") in OE-Core.

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

Patch

diff --git a/documentation/ref-manual/fragments.rst b/documentation/ref-manual/fragments.rst
index 3cd9af168..e5cd9fc43 100644
--- a/documentation/ref-manual/fragments.rst
+++ b/documentation/ref-manual/fragments.rst
@@ -224,6 +224,16 @@  This configuration fragment does multiple things:
 -  Includes the VEX statements to the input SPDX document using the
    :term:`SPDX_INCLUDE_VEX` variable.
 
+.. _ref-fragments-core-yocto-monitor-disk-space:
+
+``core/yocto/monitor-disk-space``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``core/yocto/monitor-disk-space`` :term:`configuration fragment` can be used
+to produce warnings or errors when the disk currently in use during the build
+is out of space, by setting a sensible value for the :term:`BB_DISKMON_DIRS`
+variable. See the definition of :term:`BB_DISKMON_DIRS` for more information.
+
 Yocto Project Autobuilder Fragments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~