* python/lib/gdb/printing.py: Whitespace cleanup.
authorDoug Evans <dje@google.com>
Fri, 7 Oct 2011 22:25:57 +0000 (22:25 +0000)
committerDoug Evans <dje@google.com>
Fri, 7 Oct 2011 22:25:57 +0000 (22:25 +0000)
gdb/ChangeLog
gdb/python/lib/gdb/printing.py

index 11c8e12fb0b030821db0fd641cf9e58ca6ac5b5c..0a0a57f3f06a97eb628ff79d5614751064c9e569 100644 (file)
@@ -1,5 +1,7 @@
 2011-10-07  Doug Evans  <dje@google.com>
 
+       * python/lib/gdb/printing.py: Whitespace cleanup.
+
        * python/py-value.c (valpy_call): Initialize ftype to avoid compiler
        warning.
 
index 5207659aaa4e14065d00697e7d142d5873737f36..46ffccab43da6a13307a2b820bc84a83601eaf3d 100644 (file)
@@ -26,12 +26,12 @@ class PrettyPrinter(object):
 
     Attributes:
         name: A unique string among all printers for the context in which
-              it is defined (objfile, progspace, or global(gdb)), and should
-              meaningfully describe what can be pretty-printed.
-              E.g., "StringPiece" or "protobufs".
+            it is defined (objfile, progspace, or global(gdb)), and should
+            meaningfully describe what can be pretty-printed.
+            E.g., "StringPiece" or "protobufs".
         subprinters: An iterable object with each element having a `name'
-                     attribute, and, potentially, "enabled" attribute.
-                     Or this is None if there are no subprinters.
+            attribute, and, potentially, "enabled" attribute.
+            Or this is None if there are no subprinters.
         enabled: A boolean indicating if the printer is enabled.
 
     Subprinters are for situations where "one" pretty-printer is actually a
@@ -72,13 +72,15 @@ def register_pretty_printer(obj, printer):
     """Register pretty-printer PRINTER with OBJ.
 
     The printer is added to the front of the search list, thus one can override
-    an existing printer if one needs to.
+    an existing printer if one needs to.  Use a different name when overriding
+    an existing printer, otherwise an exception will be raised; multiple
+    printers with the same name are disallowed.
 
     Arguments:
         obj: Either an objfile, progspace, or None (in which case the printer
-             is registered globally).
+            is registered globally).
         printer: Either a function of one argument (old way) or any object
-                 which has attributes: name, enabled, __call__.
+            which has attributes: name, enabled, __call__.
 
     Returns:
         Nothing.
@@ -165,7 +167,7 @@ class RegexpCollectionPrettyPrinter(PrettyPrinter):
             name: The name of the subprinter.
             regexp: The regular expression, as a string.
             gen_printer: A function/method that given a value returns an
-                         object to pretty-print it.
+                object to pretty-print it.
 
         Returns:
             Nothing.