trace: rename _read_events to read_events

[qemu.git] / scripts / tracetool / __init__.py

diff --git a/scripts/tracetool/__init__.py b/scripts/tracetool/__init__.py
index dc93416e9d468c3e7ac96154ff0597afe383561d..bf01e9341eb3491550b5dff2bdf3abd27dc6adaa 100644 (file)
--- a/scripts/tracetool/__init__.py
+++ b/scripts/tracetool/__init__.py
@@ -282,7 +282,17 @@ class Event(object):
                      self)
 
 
-def _read_events(fobj):
+def read_events(fobj):
+    """Generate the output for the given (format, backends) pair.
+
+    Parameters
+    ----------
+    fobj : file
+        Event description file.
+
+    Returns a list of Event objects
+    """
+
     events = []
     for line in fobj:
         if not line.strip():
@@ -391,6 +401,6 @@ def generate(fevents, format, backends,
     tracetool.backend.dtrace.BINARY = binary
     tracetool.backend.dtrace.PROBEPREFIX = probe_prefix
 
-    events = _read_events(fevents)
+    events = read_events(fevents)
 
     tracetool.format.generate(events, format, backend)