All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed
From: Yannic Moog <y.moog@phytec.de>
To: Simon Glass <sjg@chromium.org>,
	Alper Nebi Yasak <alpernebiyasak@gmail.com>,
	Tom Rini <trini@konsulko.com>
Cc: Fabio Estevam <festevam@gmail.com>,
	Tim Harvey <tharvey@gateworks.com>,
	Benjamin Hahn <b.hahn@phytec.de>,
	Teresa Remmet <t.remmet@phytec.de>,
	Yashwanth Varakala <y.varakala@phytec.de>,
	<upstream@lists.phytec.de>, <u-boot@lists.denx.de>,
	Yannic Moog <y.moog@phytec.de>
Subject: [PATCH RFC 6/6] binman: doc: update Optional entries
Date: Wed, 29 Jan 2025 11:29:51 +0100	[thread overview]
Message-ID: <20250129-binman_faked_optional-v1-6-a4534bc67cbb@phytec.de> (raw)
In-Reply-To: <20250129-binman_faked_optional-v1-0-a4534bc67cbb@phytec.de>

The binman documentation of Optional entries is not accurate in the
sense that it does not cover blobs entry type. As this is also the most
widely used type to have the optional entry, document the interaction
with faking blobs.

Signed-off-by: Yannic Moog <y.moog@phytec.de>
---
 tools/binman/binman.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst
index 990fc295770..2bafa6ca408 100644
--- a/tools/binman/binman.rst
+++ b/tools/binman/binman.rst
@@ -1145,7 +1145,14 @@ called on all entries.
 It is not possible for an entry to mark itself absent at any other point in the
 processing. It must happen in the ObtainContents() method.
 
-The effect is as if the entry had never been present at all, since the image
+The effect depends on the type of entry.
+
+Blobs
+~~~~~
+For blobs, the effect depends on whether --fake-ext-blobs is passed
+to binman. (This is the case by default)
+In case --fake-ext-blobs is set, any missing entries will be faked.
+If not set, it is as if the entry had never been present at all, since the image
 is packed without it and it disappears from the list of entries.
 
 

-- 
2.43.0


  parent reply	other threads:[~2025-01-29 10:31 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-29 10:29 [PATCH RFC 0/6] Fix handling of optional blobs in binman Yannic Moog
2025-01-29 10:29 ` [PATCH RFC 1/6] tools: binman: ftest.py: fake ext blobs per default Yannic Moog
2025-02-10 13:06   ` Simon Glass
2025-02-13  7:15     ` Yannic Moog
2025-02-13 14:01       ` Simon Glass
2025-02-14  7:18         ` Yannic Moog
2025-02-14 13:48           ` Simon Glass
2025-02-17  7:07             ` Yannic Moog
2025-01-29 10:29 ` [PATCH RFC 2/6] tools: binman: ftest: pass allow_fake_blob to _DoReadFileDtb Yannic Moog
2025-02-10 13:09   ` Simon Glass
2025-01-29 10:29 ` [PATCH RFC 3/6] tools: binman: ftest: fix tests that require non-faked ext blobs Yannic Moog
2025-02-10 13:09   ` Simon Glass
2025-02-13  7:15     ` Yannic Moog
2025-01-29 10:29 ` [PATCH RFC 4/6] binman: fix faked optional entry handling Yannic Moog
2025-02-10 13:09   ` Simon Glass
2025-01-29 10:29 ` [PATCH RFC 5/6] binman: test: assert optional blobs don't cause non-functionality Yannic Moog
2025-02-10 13:07   ` Simon Glass
2025-01-29 10:29 ` Yannic Moog [this message]
2025-02-10 13:08   ` [PATCH RFC 6/6] binman: doc: update Optional entries Simon Glass
2025-02-13  7:21     ` Yannic Moog
2025-02-13 14:01       ` Simon Glass
2025-02-14  7:05         ` Yannic Moog
2025-02-14 13:48           ` Simon Glass
2025-02-17  7:21             ` Yannic Moog
2025-02-17 13:13               ` Simon Glass
2025-02-18 13:15                 ` Yannic Moog
2025-02-19  0:01                   ` Simon Glass
2025-05-27  7:34                     ` Simon Glass
2025-05-27  8:12                       ` Yannic Moog
2025-05-27 12:04                         ` Simon Glass
2025-02-10 13:08 ` [PATCH RFC 0/6] Fix handling of optional blobs in binman Simon Glass

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=20250129-binman_faked_optional-v1-6-a4534bc67cbb@phytec.de \
    --to=y.moog@phytec.de \
    --cc=alpernebiyasak@gmail.com \
    --cc=b.hahn@phytec.de \
    --cc=festevam@gmail.com \
    --cc=sjg@chromium.org \
    --cc=t.remmet@phytec.de \
    --cc=tharvey@gateworks.com \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    --cc=upstream@lists.phytec.de \
    --cc=y.varakala@phytec.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.