Bug 9060: Minor update to inline documentation for new flag
[controller.git] / opendaylight / md-sal / mdsal-trace / api / src / main / yang / mdsaltrace.yang
index ce72da7..3761fa9 100644 (file)
@@ -18,11 +18,22 @@ module mdsaltrace {
     }
 
     container config {
+        // TODO leaf enabled ...
         leaf-list registration-watches {
             type string;
         }
         leaf-list write-watches {
             type string;
         }
+        leaf transaction-debug-context-enabled {
+            default false;
+            type boolean;
+            description "Enable or disable transaction context debug. This will preserve the call site trace for
+                         transactions, so that the original caller of un-close'd() transaction can be identified.
+                         NB: This is a different property from the equally named one in etc/org.opendaylight.controller.cluster.datastore.cfg;
+                         that one does something somewhat similar, but serves to include the stack trace on failed transaction submit,
+                         whereas this one is specific to odl-mdsal-trace's trace:transaction leak troubleshooting command.";
+            // This ^^^ description is also copy/pasted in mdsaltrace_config.xml, and should be kept in line.]
+        }
     }
 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.