Bug 9060: Minor update to inline documentation for new flag
[controller.git] / opendaylight / md-sal / mdsal-trace / api / src / main / yang / mdsaltrace.yang
1 module mdsaltrace {
2     yang-version 1;
3     namespace "urn:opendaylight:params:xml:ns:yang:mdsaltrace";
4     prefix "mdsaltrace";
5
6     organization
7         "Red Hat, Inc.";
8
9     description
10         "Copyright (c) 2016 Red Hat, Inc. and others.  All rights reserved.
11
12         This program and the accompanying materials are made available under the
13         terms of the Eclipse Public License v1.0 which accompanies this distribution,
14         and is available at http://www.eclipse.org/legal/epl-v10.html";
15
16     revision "2016-09-08" {
17         description "Initial revision of mdsaltrace model";
18     }
19
20     container config {
21         // TODO leaf enabled ...
22         leaf-list registration-watches {
23             type string;
24         }
25         leaf-list write-watches {
26             type string;
27         }
28         leaf transaction-debug-context-enabled {
29             default false;
30             type boolean;
31             description "Enable or disable transaction context debug. This will preserve the call site trace for
32                          transactions, so that the original caller of un-close'd() transaction can be identified.
33                          NB: This is a different property from the equally named one in etc/org.opendaylight.controller.cluster.datastore.cfg;
34                          that one does something somewhat similar, but serves to include the stack trace on failed transaction submit,
35                          whereas this one is specific to odl-mdsal-trace's trace:transaction leak troubleshooting command.";
36             // This ^^^ description is also copy/pasted in mdsaltrace_config.xml, and should be kept in line.]
37         }
38     }
39 }

©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.