diff options
author | Scott Murray <scott.murray@konsulko.com> | 2022-02-17 17:09:34 -0500 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-02-21 23:37:26 +0000 |
commit | 4f77505d94a8f6260933f457e9848d1d2fa98ce5 (patch) | |
tree | 89d4bbbf29d4d824e65c93754c9522993c5a3290 /bitbake/doc | |
parent | 424269caeadd21b01a860d032ca81167c7ce7239 (diff) | |
download | poky-4f77505d94a8f6260933f457e9848d1d2fa98ce5.tar.gz |
bitbake: lib/bb: Replace "ABORT" action in BB_DISKMON_DIRS
In line with the inclusive language migration defined at:
https://wiki.yoctoproject.org/wiki/Inclusive_language
replace the "ABORT" action in BB_DISKMON_DIRS entries with "HALT".
In order to ease migration, code has been added to warn users to
update their configurations if the old name is used, as opposed to
to throwing an error.
(Bitbake rev: 11dc65dc077398ff9818060769c99c0090291186)
Signed-off-by: Scott Murray <scott.murray@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 7601d15a0e..315086a6ec 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | |||
@@ -138,7 +138,7 @@ overview of their function and contents. | |||
138 | where: | 138 | where: |
139 | 139 | ||
140 | <action> is: | 140 | <action> is: |
141 | ABORT: Immediately abort the build when | 141 | HALT: Immediately halt the build when |
142 | a threshold is broken. | 142 | a threshold is broken. |
143 | STOPTASKS: Stop the build after the currently | 143 | STOPTASKS: Stop the build after the currently |
144 | executing tasks have finished when | 144 | executing tasks have finished when |
@@ -169,13 +169,13 @@ overview of their function and contents. | |||
169 | 169 | ||
170 | Here are some examples:: | 170 | Here are some examples:: |
171 | 171 | ||
172 | BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" | 172 | BB_DISKMON_DIRS = "HALT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" |
173 | BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" | 173 | BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" |
174 | BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" | 174 | BB_DISKMON_DIRS = "HALT,${TMPDIR},,100K" |
175 | 175 | ||
176 | The first example works only if you also set the | 176 | The first example works only if you also set the |
177 | :term:`BB_DISKMON_WARNINTERVAL` | 177 | :term:`BB_DISKMON_WARNINTERVAL` |
178 | variable. This example causes the build system to immediately abort | 178 | variable. This example causes the build system to immediately halt |
179 | when either the disk space in ``${TMPDIR}`` drops below 1 Gbyte or | 179 | when either the disk space in ``${TMPDIR}`` drops below 1 Gbyte or |
180 | the available free inodes drops below 100 Kbytes. Because two | 180 | the available free inodes drops below 100 Kbytes. Because two |
181 | directories are provided with the variable, the build system also | 181 | directories are provided with the variable, the build system also |
@@ -189,7 +189,7 @@ overview of their function and contents. | |||
189 | directory drops below 1 Gbyte. No disk monitoring occurs for the free | 189 | directory drops below 1 Gbyte. No disk monitoring occurs for the free |
190 | inodes in this case. | 190 | inodes in this case. |
191 | 191 | ||
192 | The final example immediately aborts the build when the number of | 192 | The final example immediately halts the build when the number of |
193 | free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No | 193 | free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No |
194 | disk space monitoring for the directory itself occurs in this case. | 194 | disk space monitoring for the directory itself occurs in this case. |
195 | 195 | ||