summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Elberger <rich@richelberger.com>2023-02-25 16:36:06 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-02-25 23:10:02 +0000
commit6bc65e6402a74c9a65e29333a7e0f1f85dcbcf58 (patch)
treeb87b939c4686d56390df18a855558c342f6b943a
parent0ac6f6cb5d807919ed13a8b7bb3fb551b79c5a71 (diff)
downloadbitbake-6bc65e6402a74c9a65e29333a7e0f1f85dcbcf58.tar.gz
documentation: bitbake: add file-checksums to varflags section
Fixes [YOCTO #11605] by: - Adding definition of file-checksums to Variable Flags section. - Describe data to add to list which adds external file dependencies. - Write example on usage to prepend a value to file-checksums list. Signed-off-by: Richard Elberger <rich@richelberger.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-metadata.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index deb7afad4..ba8129afa 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -1496,6 +1496,23 @@ functionality of the task:
directory listed is used as the current working directory for the
task.
+- ``[file-checksums]``: Controls the file dependencies for a task. The
+ baseline file list is the set of files associated with
+ :term:`SRC_URI`. May be used to set additional dependencies on
+ files not associated with :term:`SRC_URI`.
+
+ The value set to the list is a file-boolean pair where the first
+ value is the file name and the second is whether or not it
+ physically exists on the filesystem. ::
+
+ do_configure[file-checksums] += "${MY_DIRPATH}/my-file.txt:True"
+
+ It is important to record any paths which the task looked at and
+ which didn't exist. This means that if these do exist at a later
+ time, the task can be rerun with the new additional files. The
+ "exists" True or False value after the path allows this to be
+ handled.
+
- ``[lockfiles]``: Specifies one or more lockfiles to lock while the
task executes. Only one task may hold a lockfile, and any task that
attempts to lock an already locked file will block until the lock is