binman: Add missing comments toentry
At present GetOffsets() lacks a function comment. Add one.
Signed-off-by: Simon Glass <sjg@chromium.org>
diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index d842d89..e8d0ade 100644
--- a/tools/binman/entry.py
+++ b/tools/binman/entry.py
@@ -355,6 +355,21 @@
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):