From: Ryan Goulding <ryandgoulding@gmail.com>
Date: Fri, 24 Jun 2016 15:54:20 +0000 (-0400)
Subject: Add a description to "rate" in the cars model
X-Git-Tag: release/boron~97
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=fe8e6082f593698758d3d496f130b556dae0c475;hp=a91b26928a39de1aa0ed331efa8c17ae58d5681f

Add a description to "rate" in the cars model

While using this model for some performance testing, I realized I had no idea
what rate meant initially.  This change adds an appropriate description to the
rate leaf.

Change-Id: Idfd613f91e00de912784da55076ec7b13812fdd2
Signed-off-by: Ryan Goulding <ryandgoulding@gmail.com>
---

diff --git a/opendaylight/md-sal/samples/clustering-test-app/model/src/main/yang/car.yang b/opendaylight/md-sal/samples/clustering-test-app/model/src/main/yang/car.yang
index 2f6079a32f..35e82039a3 100644
--- a/opendaylight/md-sal/samples/clustering-test-app/model/src/main/yang/car.yang
+++ b/opendaylight/md-sal/samples/clustering-test-app/model/src/main/yang/car.yang
@@ -64,6 +64,10 @@ module car {
         input {
             leaf rate {
               type uint16;
+              description "The rate is a measure of the number of car-entry(s) added per second.
+                           Thus the rate is measured in terms of transactions per second.  The
+                           rate is not necessary achievable;  the controller may not keep up with
+                           the specified value.  In this instance, rate is considered maximum rate.";
             }
 
             leaf count {