]> git.puffer.fish Git - matthieu/frr.git/commitdiff
yang: route-map model description format
authorChirag Shah <chirag@cumulusnetworks.com>
Wed, 29 Jul 2020 20:03:35 +0000 (13:03 -0700)
committerChirag Shah <chirag@cumulusnetworks.com>
Fri, 31 Jul 2020 23:21:45 +0000 (16:21 -0700)
Added "." at the enf of each description of fields.

Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>
yang/frr-route-map.yang

index f13cf8e3248fa8f290d9c141dfc76f53a727d342..b895cd12a4f748a586327275b351d3781b405333 100644 (file)
@@ -61,13 +61,13 @@ module frr-route-map {
       range "1..65535";
     }
     description
-      "Route map valid sequence numbers";
+      "Route map valid sequence numbers.";
   }
 
   typedef route-map-name {
     type string;
     description
-      "Route map name format";
+      "Route map name format.";
   }
 
   typedef route-map-ref {
@@ -86,31 +86,31 @@ module frr-route-map {
     list route-map {
       key "name";
       description
-        "Route map instance";
+        "Route map instance.";
       leaf name {
         type route-map-name;
         description
-          "Route map instance name";
+          "Route map instance name.";
       }
 
       list entry {
         key "sequence";
         description
-          "Route map entry";
+          "Route map entry.";
         leaf sequence {
           description
-            "Route map instance priority (low number means higher priority)";
+            "Route map instance priority (low number means higher priority).";
           type route-map-sequence;
         }
 
         leaf description {
-          description "Route map description";
+          description "Route map description.";
           type string;
         }
 
         leaf action {
           description
-            "Route map actions: permit (executes action), deny (quits evaluation)";
+            "Route map actions: permit (executes action), deny (quits evaluation).";
           mandatory true;
           type enumeration {
             enum permit {
@@ -134,25 +134,25 @@ module frr-route-map {
           description
             "Call another route map before calling `exit-policy`. If the
              called route map returns deny then this route map will also
-             return deny";
+             return deny.";
           type route-map-name;
         }
 
         leaf exit-policy {
-          description "What do to after route map successful match, set and call";
+          description "What do to after route map successful match, set and call.";
           type enumeration {
             enum permit-or-deny {
-              description "End route map evaluation and return";
+              description "End route map evaluation and return.";
               value 0;
             }
             enum next {
               description
-                "Proceed evaluating next route map entry per sequence";
+                "Proceed evaluating next route map entry per sequence.";
               value 1;
             }
             enum goto {
               description
-                "Go to route map entry with the provided sequence number";
+                "Go to route map entry with the provided sequence number.";
               value 2;
             }
           }
@@ -162,7 +162,7 @@ module frr-route-map {
         leaf goto-value {
           when "../exit-policy = 'goto'";
           description
-            "Sequence number to jump (when using `goto` exit policy)";
+            "Sequence number to jump (when using `goto` exit policy).";
           mandatory true;
           type route-map-sequence;
         }
@@ -170,73 +170,73 @@ module frr-route-map {
         list match-condition {
           key "condition";
           description
-            "Route map match conditions";
+            "Route map match conditions.";
           leaf condition {
-            description "Match condition";
+            description "Match condition.";
             type enumeration {
               enum interface {
-                description "Match interface";
+                description "Match interface.";
                 value 0;
               }
               enum ipv4-address-list {
-                description "Match an IPv4 access-list";
+                description "Match an IPv4 access-list.";
                 value 1;
               }
               enum ipv4-prefix-list {
-                description "Match an IPv4 prefix-list";
+                description "Match an IPv4 prefix-list.";
                 value 2;
               }
               enum ipv4-next-hop-list {
-                description "Match an IPv4 next-hop";
+                description "Match an IPv4 next-hop.";
                 value 3;
               }
               enum ipv4-next-hop-prefix-list {
-                description "Match an IPv4 next-hop prefix list";
+                description "Match an IPv4 next-hop prefix list.";
                 value 4;
               }
               enum ipv4-next-hop-type {
-                description "Match an IPv4 next-hop type";
+                description "Match an IPv4 next-hop type.";
                 value 5;
               }
               enum ipv6-address-list {
-                description "Match an IPv6 access-list";
+                description "Match an IPv6 access-list.";
                 value 6;
               }
               enum ipv6-prefix-list {
-                description "Match an IPv6 prefix-list";
+                description "Match an IPv6 prefix-list.";
                 value 7;
               }
               enum ipv6-next-hop-type {
-                description "Match an IPv6 next-hop type";
+                description "Match an IPv6 next-hop type.";
                 value 8;
               }
               enum metric {
-                description "Match a route metric";
+                description "Match a route metric.";
                 value 9;
               }
               enum tag {
-                description "Match a route tag";
+                description "Match a route tag.";
                 value 10;
               }
               /* zebra specific conditions. */
               enum ipv4-prefix-length {
-                description "Match IPv4 prefix length";
+                description "Match IPv4 prefix length.";
                 value 100;
               }
               enum ipv6-prefix-length {
-                description "Match IPv6 prefix length";
+                description "Match IPv6 prefix length.";
                 value 101;
               }
               enum ipv4-next-hop-prefix-length {
-                description "Match next-hop prefix length";
+                description "Match next-hop prefix length.";
                 value 102;
               }
               enum source-protocol {
-                description "Match source protocol";
+                description "Match source protocol.";
                 value 103;
               }
               enum source-instance {
-                description "Match source protocol instance";
+                description "Match source protocol instance.";
                 value 104;
               }
             }
@@ -244,7 +244,7 @@ module frr-route-map {
 
           choice condition-value {
             description
-              "Value to match (interpretation depends on condition type)";
+              "Value to match (interpretation depends on condition type).";
             mandatory true;
             case interface {
               when "./condition = 'interface'";
@@ -308,32 +308,32 @@ module frr-route-map {
         }
 
         list set-action {
-          description "Route map set actions";
+          description "Route map set actions.";
 
           key "action";
 
           leaf action {
-            description "Action to do when the route map matches";
+            description "Action to do when the route map matches.";
             type enumeration {
               enum ipv4-next-hop {
-                description "Set IPv4 address of the next hop";
+                description "Set IPv4 address of the next hop.";
                 value 0;
               }
               enum ipv6-next-hop {
-                description "Set IPv6 address of the next hop";
+                description "Set IPv6 address of the next hop.";
                 value 1;
               }
               enum metric {
-                description "Set prefix/route metric";
+                description "Set prefix/route metric.";
                 value 2;
               }
               enum tag {
-                description "Set tag";
+                description "Set tag.";
                 value 3;
               }
               /* zebra specific conditions. */
               enum source {
-                description "Set source address for route";
+                description "Set source address for route.";
                 value 100;
               }
             }
@@ -341,11 +341,11 @@ module frr-route-map {
 
           choice action-value {
             description
-              "Value to set (interpretation depends on action-type)";
+              "Value to set (interpretation depends on action-type).";
             case ipv4-address {
               when "./action = 'ipv4-next-hop'";
               leaf ipv4-address {
-                description "IPv4 address";
+                description "IPv4 address.";
                 type inet:ipv4-address;
               }
             }
@@ -353,7 +353,7 @@ module frr-route-map {
             case ipv6-address {
               when "./action = 'ipv6-next-hop'";
               leaf ipv6-address {
-                description "IPv6 address";
+                description "IPv6 address.";
                 type inet:ipv6-address;
               }
             }
@@ -361,10 +361,10 @@ module frr-route-map {
             case metric {
               when "./action = 'metric'";
               choice metric-value {
-                description "Metric to set or use";
+                description "Metric to set or use.";
                 case value {
                   leaf value {
-                    description "Use the following metric value";
+                    description "Use the following metric value.";
                     type uint32 {
                       range "0..4294967295";
                     }
@@ -373,35 +373,35 @@ module frr-route-map {
 
                 case add-metric {
                   leaf add-metric {
-                    description "Add unit to metric";
+                    description "Add unit to metric.";
                     type boolean;
                   }
                 }
 
                 case subtract-metric {
                   leaf subtract-metric {
-                    description "Subtract unit from metric";
+                    description "Subtract unit from metric.";
                     type boolean;
                   }
                 }
 
                 case use-round-trip-time {
                   leaf use-round-trip-time {
-                    description "Use the round trip time as metric";
+                    description "Use the round trip time as metric.";
                     type boolean;
                   }
                 }
 
                 case add-round-trip-time {
                   leaf add-round-trip-time {
-                    description "Add round trip time to metric";
+                    description "Add round trip time to metric.";
                     type boolean;
                   }
                 }
 
                 case subtract-round-trip-time {
                   leaf subtract-round-trip-time {
-                    description "Subtract round trip time to metric";
+                    description "Subtract round trip time to metric.";
                     type boolean;
                   }
                 }
@@ -411,7 +411,7 @@ module frr-route-map {
             case tag {
               when "./action = 'tag'";
               leaf tag {
-                description "Tag value";
+                description "Tag value.";
                 type uint32 {
                   range "0..4294967295";
                 }