From: Michael Vorburger <vorburger@redhat.com>
Date: Thu, 31 Aug 2017 16:19:47 +0000 (+0200)
Subject: Bug 9060: Minor update to inline documentation for new flag
X-Git-Tag: release/oxygen~115
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=3c955d3078711dfa8ca2daeeceac1cc6811df94a;hp=88a6b2f0a11ac2318795b0e9124ac596a386304a;ds=sidebyside

Bug 9060: Minor update to inline documentation for new flag

Change-Id: Id2eb1e76a8658e837166b227a30cd49ee665c258
Signed-off-by: Michael Vorburger <vorburger@redhat.com>
---

diff --git a/opendaylight/md-sal/mdsal-trace/api/src/main/resources/initial/mdsaltrace_config.xml b/opendaylight/md-sal/mdsal-trace/api/src/main/resources/initial/mdsaltrace_config.xml
index 13b5d86fdd..9dfd362065 100644
--- a/opendaylight/md-sal/mdsal-trace/api/src/main/resources/initial/mdsaltrace_config.xml
+++ b/opendaylight/md-sal/mdsal-trace/api/src/main/resources/initial/mdsaltrace_config.xml
@@ -2,5 +2,12 @@
     <!-- <registration-watches>/neutron-router-dpns/router-dpn-list</registration-watches> -->
     <!-- <registration-watches>/tunnels_state/state-tunnel-list</registration-watches> -->
     <!-- <write-watches> /NetworkTopology/Topology</write-watches> -->
+
+    <!-- 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 documentation has been copy/pasted from mdsaltrace.yang, and should be kept in line.] -->
     <transaction-debug-context-enabled>true</transaction-debug-context-enabled>
 </config>
diff --git a/opendaylight/md-sal/mdsal-trace/api/src/main/yang/mdsaltrace.yang b/opendaylight/md-sal/mdsal-trace/api/src/main/yang/mdsaltrace.yang
index 5c6b09b5bf..3761fa9c1d 100644
--- a/opendaylight/md-sal/mdsal-trace/api/src/main/yang/mdsaltrace.yang
+++ b/opendaylight/md-sal/mdsal-trace/api/src/main/yang/mdsaltrace.yang
@@ -29,7 +29,11 @@ module mdsaltrace {
             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";
+                         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.]
         }
     }
 }