diff mbox series

[U-Boot,v2,11/37] binman: Add missing comments toentry

Message ID	20190708191856.138863-12-sjg@chromium.org
State	Accepted
Commit	ed7dd5e61ca5ae60087c2c6ee90d6d729c18764c
Delegated to:	Simon Glass
Headers	show Return-Path: <u-boot-bounces@lists.denx.de> From: Simon Glass <sjg@chromium.org> To: U-Boot Mailing List <u-boot@lists.denx.de> Date: Mon, 8 Jul 2019 13:18:30 -0600 Message-Id: <20190708191856.138863-12-sjg@chromium.org> In-Reply-To: <20190708191856.138863-1-sjg@chromium.org> References: <20190708191856.138863-1-sjg@chromium.org> MIME-Version: 1.0 Subject: [U-Boot] [PATCH v2 11/37] binman: Add missing comments toentry Precedence: list Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" <u-boot-bounces@lists.denx.de>
Series	binman: Add CBFS support \| expand [U-Boot,v2,00/37] binman: Add CBFS support [U-Boot,v2,01/37] x86: Add ifwitool for Intel Integrated Firmware Image [U-Boot,v2,02/37] cbfs: Add an enum and comment for the magic number [U-Boot,v2,03/37] cbfs: Rename checksum to attributes_offset [U-Boot,v2,04/37] tools: Drop duplicate raise_on_error argument [U-Boot,v2,05/37] binman: Fix comment in bsection.GetEntries() [U-Boot,v2,06/37] binman: Correct two typos in function names in ftest [U-Boot,v2,07/37] binman: Add coverage tools info for Python 3 [U-Boot,v2,08/37] patman: Add a way to set the search path for tools [U-Boot,v2,09/37] binman: Add a --toolpath option to set the tool search path [U-Boot,v2,10/37] binman: Add missing comments to bsection [U-Boot,v2,11/37] binman: Add missing comments toentry [U-Boot,v2,12/37] binman: Tidy up help for --indir [U-Boot,v2,13/37] binman: Use a better error for missing Intel descriptor [U-Boot,v2,14/37] binman: Detect skipped tests [U-Boot,v2,15/37] binman: Add a function to create a sample ELF file [U-Boot,v2,16/37] binman: Add a function to decode an ELF file [U-Boot,v2,17/37] binman: Ensure that coverage has access to site packages [U-Boot,v2,18/37] binman: Assume Intel descriptor is at the start of the image [U-Boot,v2,19/37] binman: Don't assume there is an ME region [U-Boot,v2,20/37] binman: Update entry.SetOffsetSize to be optional [U-Boot,v2,21/37] binman: Allow text directly in the node [U-Boot,v2,22/37] patman: Add functions to compress and decompress data [U-Boot,v2,23/37] binman: Use the tools.Decompress method [U-Boot,v2,24/37] binman: Drop unnecessary debug handling [U-Boot,v2,25/37] binman: Use tools compression function for blob handling [U-Boot,v2,26/37] binman: Correct comment in u_boot_spl_elf [U-Boot,v2,27/37] binman: Support ELF files for TPL [U-Boot,v2,28/37] binman: Fix up the _DoTestFile() function -u argument [U-Boot,v2,29/37] binman: Allow verbosity control when running tests [U-Boot,v2,30/37] binman: Allow preserving test directories [U-Boot,v2,31/37] binman: Pass the toolpath to tests [U-Boot,v2,32/37] patman: Add a function to write ifwitool [U-Boot,v2,33/37] binman: Add a utility library for coreboot CBFS [U-Boot,v2,34/37] binman: Add support for CBFS entries [U-Boot,v2,35/37] binman: Add support for Intel IFWI entries [U-Boot,v2,36/37] binman: Pad empty areas of the CBFS with files [U-Boot,v2,37/37] binman: Add support for fixed-offset files in CBFS

Commit Message

Simon Glass July 8, 2019, 7:18 p.m. UTC

At present GetOffsets() lacks a function comment. Add one.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

Changes in v2: None

 tools/binman/entry.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Simon Glass July 18, 2019, 1:59 a.m. UTC | #1

At present GetOffsets() lacks a function comment. Add one.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

Changes in v2: None

 tools/binman/entry.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Applied to u-boot-dm, thanks!

diff mbox series

Patch

diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index d842d89dd66..e8d0adec1e9 100644
--- a/tools/binman/entry.py
+++ b/tools/binman/entry.py
@@ -355,6 +355,21 @@  class Entry(object):
         return self.data
 
     def GetOffsets(self):
+        """Get the offsets for siblings
+
+        Some entry types can contain information about the position or size of
+        other entries. An example of this is the Intel Flash Descriptor, which
+        knows where the Intel Management Engine section should go.
+
+        If this entry knows about the position of other entries, it can specify
+        this by returning values here
+
+        Returns:
+            Dict:
+                key: Entry type
+                value: List containing position and size of the given entry
+                    type.
+        """
         return {}
 
     def SetOffsetSize(self, pos, size):