summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2019-07-08 13:18:29 -0600
committerSimon Glass <sjg@chromium.org>2019-07-23 20:27:57 -0700
commit36b246e71f91b6de231b77fbd4000997b79b1064 (patch)
tree0ffbe17da86f5dd019fe44fd3900fbdbcd854f15
parentc7d8035ec185c789f8182c7d3374db4dcdbd250b (diff)
binman: Add missing comments to bsection
Some functions lack comments in this file. Add comments to cover this functionality. Signed-off-by: Simon Glass <sjg@chromium.org>
-rw-r--r--tools/binman/bsection.py23
1 files changed, 23 insertions, 0 deletions
diff --git a/tools/binman/bsection.py b/tools/binman/bsection.py
index a3026718794..e0e3707db41 100644
--- a/tools/binman/bsection.py
+++ b/tools/binman/bsection.py
@@ -452,13 +452,36 @@ class Section(object):
source_entry.Raise("Cannot find entry for node '%s'" % node.name)
def ExpandSize(self, size):
+ """Change the size of an entry
+
+ Args:
+ size: New size for entry
+ """
if size != self._size:
self._size = size
def GetRootSkipAtStart(self):
+ """Get the skip-at-start value for the top-level section
+
+ This is used to find out the starting offset for root section that
+ contains this section. If this is a top-level section then it returns
+ the skip-at-start offset for this section.
+
+ This is used to get the absolute position of section within the image.
+
+ Returns:
+ Integer skip-at-start value for the root section containing this
+ section
+ """
if self._parent_section:
return self._parent_section.GetRootSkipAtStart()
return self._skip_at_start
def GetImageSize(self):
+ """Get the size of the image containing this section
+
+ Returns:
+ Image size as an integer number of bytes, which may be None if the
+ image size is dynamic and its sections have not yet been packed
+ """
return self._image._size