binman: Document ExpandEntries() in the base class

Move the documentation to the base method as it is with other methods.
Also update it a little while we are here.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2021-03-18 20:24:52 +13:00
parent 862ddf9100
commit a01d1a25bc
2 changed files with 11 additions and 6 deletions

View File

@ -211,6 +211,17 @@ class Entry(object):
return {}
def ExpandEntries(self):
"""Expand out entries which produce other entries
Some entries generate subnodes automatically, from which sub-entries
are then created. This method allows those to be added to the binman
definition for the current image. An entry which implements this method
should call state.AddSubnode() to add a subnode and can add properties
with state.AddString(), etc.
An example is 'files', which produces a section containing a list of
files.
"""
pass
def AddMissingProperties(self, have_image_pos):

View File

@ -126,12 +126,6 @@ class Entry_section(Entry):
return True
def ExpandEntries(self):
"""Expand out any entries which have calculated sub-entries
Some entries are expanded out at runtime, e.g. 'files', which produces
a section containing a list of files. Process these entries so that
this information is added to the device tree.
"""
super().ExpandEntries()
for entry in self._entries.values():
entry.ExpandEntries()