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>

diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index d58a730f3d56dde5b2084668e732e19b9755ceb9..507760e2a861b11e442e0add6c6b70506ec05204 100644 (file)
--- a/tools/binman/entry.py
+++ b/tools/binman/entry.py
@@ -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):

diff --git a/tools/binman/etype/section.py b/tools/binman/etype/section.py
index 1ceadef13f39f5f3e047a6bced91df88b252695a..2103919b0c32715fabca39d67e9aee60e769e04e 100644 (file)
--- a/tools/binman/etype/section.py
+++ b/tools/binman/etype/section.py
@@ -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()