From ed7dd5e61ca5ae60087c2c6ee90d6d729c18764c Mon Sep 17 00:00:00 2001
From: Simon Glass <sjg@chromium.org>
Date: Mon, 8 Jul 2019 13:18:30 -0600
Subject: [PATCH] binman: Add missing comments toentry
At present GetOffsets() lacks a function comment. Add one.
Signed-off-by: Simon Glass <sjg@chromium.org>
---
tools/binman/entry.py | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index d842d89dd6..e8d0adec1e 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):
--
2.39.5