($INBOX_DIR/description missing)
 help / color / mirror / Atom feed
From: Luca Ceresoli <luca.ceresoli@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Luca Ceresoli <luca.ceresoli@bootlin.com>
Subject: [PATCH] ref-manual: tasks: do_cleanall: mention it is not allowed with a shared DL_DIR
Date: Mon, 19 Feb 2024 16:55:13 +0100	[thread overview]
Message-ID: <20240219155513.76738-1-luca.ceresoli@bootlin.com> (raw)

do_cleanall can produce failures if using a shared download directory. This
is why it is forbidden when writing tests that will run on the autobuilders
(https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests).

Reported-by: Sam Liddicott
Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 documentation/ref-manual/tasks.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 0db960b22f80..c754eb15514b 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -474,6 +474,19 @@ Typically, you would not normally use the :ref:`ref-tasks-cleanall` task. Do so
 if you want to start fresh with the :ref:`ref-tasks-fetch`
 task.
 
+.. note::
+
+   Never run the :ref:`ref-tasks-cleanall` task if your :term:`DL_DIR` is
+   shared. This would break in this scenario::
+
+      dir1$ bitbake <recipe> -c fetch
+      dir2$ bitbake <recipe> -c cleanall
+      dir1$ bitbake <recipe> -c unpack
+
+   because before step 3 in dir1 there is a stamp file for the
+   :ref:`ref-tasks-fetch` task, so the unpack task will try to extract the
+   downloaded archive and fail as it has been deleted in step 2.
+
 .. _ref-tasks-cleansstate:
 
 ``do_cleansstate``
-- 
2.34.1



             reply	other threads:[~2024-02-19 15:55 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-19 15:55 Luca Ceresoli [this message]
2024-02-19 16:12 ` [docs] [PATCH] ref-manual: tasks: do_cleanall: mention it is not allowed with a shared DL_DIR Quentin Schulz
2024-02-20  7:58   ` Luca Ceresoli
2024-02-20  9:01     ` Richard Purdie
2024-02-20 10:20       ` Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240219155513.76738-1-luca.ceresoli@bootlin.com \
    --to=luca.ceresoli@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).