summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2024-08-26 13:11:31 -0600
committerSimon Glass <sjg@chromium.org>2024-09-26 12:40:30 +0200
commitbe45bb941abe18aea0ae03af3d4ce8797885916f (patch)
tree2a8a6305fb0f9f3bb9b922d3c7199593af1f523e
parent548e86198bd0bf659118bd8f9060c927b77e6e6e (diff)
binman: Tidy up comments for Entry.GetEntryArgsOrProps()
Improve the comments for this function. Signed-off-by: Simon Glass <sjg@chromium.org>
-rw-r--r--tools/binman/entry.py10
1 files changed, 9 insertions, 1 deletions
diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index 6d2f3789940..7d4d4692776 100644
--- a/tools/binman/entry.py
+++ b/tools/binman/entry.py
@@ -576,8 +576,16 @@ class Entry(object):
def GetEntryArgsOrProps(self, props, required=False):
"""Return the values of a set of properties
+ Looks up the named entryargs and returns the value for each. If any
+ required ones are missing, the error is reported to the user.
+
Args:
- props: List of EntryArg objects
+ props (list of EntryArg): List of entry arguments to look up
+ required (bool): True if these entry arguments are required
+
+ Returns:
+ list of values: one for each item in props, the type is determined
+ by the EntryArg's 'datatype' property (str or int)
Raises:
ValueError if a property is not found