[babel] [patch] Info model: fix little inconsistencies in naming, use singular for objects.

Antonin Décimo <antonin.decimo@gmail.com> Tue, 21 January 2020 19:49 UTC

Return-Path: <antonin.decimo@gmail.com>
X-Original-To: babel@ietfa.amsl.com
Delivered-To: babel@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 577E0120890 for <babel@ietfa.amsl.com>; Tue, 21 Jan 2020 11:49:24 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.998
X-Spam-Level:
X-Spam-Status: No, score=-1.998 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id pR-o27efyk3k for <babel@ietfa.amsl.com>; Tue, 21 Jan 2020 11:49:21 -0800 (PST)
Received: from mail-ot1-x330.google.com (mail-ot1-x330.google.com [IPv6:2607:f8b0:4864:20::330]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id B633912084D for <babel@ietf.org>; Tue, 21 Jan 2020 11:49:21 -0800 (PST)
Received: by mail-ot1-x330.google.com with SMTP id a15so4116089otf.1 for <babel@ietf.org>; Tue, 21 Jan 2020 11:49:21 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:from:date:message-id:subject:to; bh=3VkAExEKHP2IVAKxGthUPE5XndQN/SUrZ6CkXigmcUI=; b=M94jYA9XbTQgjP4llOSokhgp9BzX+LSlwyFY3JH5lj3OOtM1ofkNW1afXqCZNm/fyA 8wjXXEf6vEe7yAW1UQ0GifmDU1CqI6zq8VJiTThs+kjINBSgY95wW6RqWWjUYnvRogBV xaKWb5zLdmPifvcUbenP4gL4j9hn3ffhHMl8t1C8wSqRO+zYK0eDR6j0D8+XETBGS30R RZ/ldWZSyh81N4OptRz/7h8+ls4U+cBIWg+c/BYxEVZ7pVlnmL+J/3W+0IXYaRl3/DmD Dn+JWb/InsqrU83h4WL4rzpWQVwi+0HxZ/4NnSwus3LcOfn98IEBBI5KKFiZ9ENV9ANQ dAzw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=3VkAExEKHP2IVAKxGthUPE5XndQN/SUrZ6CkXigmcUI=; b=m2M2w/b7ojUgM+zlGyrBiE0rpsUZneGPitW2znKcdwXFKASeyTWAseDpAgPiodvZ38 Agc7tNrZkYKXgJQ/OET5I3a5kYu7iFoCOSb8k5UUp1hh5BH8NI3yWjDv23zKEUH5Glck Cr+BADqIkPsLi2wourZn3M1vcdpaO7hpA9aHmeRjyUtn+16zWy0Ca6F6OzS5VStWKS7L 9dqwwjwkTvqYDz34bHr+8ggWMtBHdYktMDW6yQflWIdclT2Hq1VD3dmmHbvUrhF21G/m i2ciRbQ6+z023KAaBRz4DNFw8x3Vv8Ljo4E7ghZel5GnfHQm9KbMwd4kl4JL6W4iuPC9 7dVQ==
X-Gm-Message-State: APjAAAXCVOXk7RBGTZ91wLunG1BHTveYtFF3tYLHqey4ndY6jwFSEfPM wpmGTfrdMivzt93dSdg/PuHFR6OufvqD0wI4ny2WQAFK
X-Google-Smtp-Source: APXvYqxbZw9oAKLubzTck5R/i1K2rdIZshTCHCORQev0M/e5yg/bXJnDkCGxEZ+KBYAwMokyqZy3zIRyLKoW+sdpeP0=
X-Received: by 2002:a9d:3b09:: with SMTP id z9mr4845680otb.195.1579636160798; Tue, 21 Jan 2020 11:49:20 -0800 (PST)
MIME-Version: 1.0
From: Antonin Décimo <antonin.decimo@gmail.com>
Date: Tue, 21 Jan 2020 20:49:40 +0100
Message-ID: <CAC=54BKONDYv44iY6kRPO9pADe=mE+naRDa2n027X8sng+ZKmw@mail.gmail.com>
To: "Barbara H. Stark" <bs7652@att.com>, Mahesh Jethanandani <mjethanandani@gmail.com>, "babel@ietf.org" <babel@ietf.org>
Content-Type: text/plain; charset="UTF-8"
Archived-At: <https://mailarchive.ietf.org/arch/msg/babel/bkuO-GxnTpWyWbqFlqss4vi_IM0>
Subject: [babel] [patch] Info model: fix little inconsistencies in naming, use singular for objects.
X-BeenThere: babel@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "A list for discussion of the Babel Routing Protocol." <babel.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/babel>, <mailto:babel-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/babel/>
List-Post: <mailto:babel@ietf.org>
List-Help: <mailto:babel-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/babel>, <mailto:babel-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 21 Jan 2020 19:49:24 -0000

Hello Barbara, hello Mahesh,

While reading carefully the Information Model with all the recent
discussions, I've found some small inconsistencies in the naming of
objects which I've fixed in the patch below.

What bothered me more was that the name of object types was
pluralized.  I'm much more comfortable with singular, for instance I
find it better to read "Definition of babel-route-obj" and then the
composition of the object, rather than "Definition of
babel-routes-obj": why was it pluralized?
I also find it better to have the field (for instance)
"babel-routes<0..*>;" be a set of objects of type "babel-route-obj".

-- Antonin

---
 draft-ietf-babel-information-model.md | 56 +++++++++++++--------------
 1 file changed, 28 insertions(+), 28 deletions(-)

diff --git a/draft-ietf-babel-information-model.md
b/draft-ietf-babel-information-model.md
index ad2a64a..9b66f2d 100644
--- a/draft-ietf-babel-information-model.md
+++ b/draft-ietf-babel-information-model.md
@@ -15,7 +15,7 @@ title: Babel Information Model
 area: Routing
 wg: Babel routing protocol
 kw: Babel
-date: 2019
+date: 2020
 author:
 - ins: B. H. Stark
   name: Barbara Stark
@@ -332,10 +332,10 @@ model definitions in subsequent sections, the
error is in this overview.
       [boolean                  rw babel-stats-enable;]
       [operation                   babel-stats-reset;]
        babel-constants-obj      ro babel-constants;
-       babel-interfaces-obj     ro babel-interfaces<0..*>;
-       babel-routes-obj         ro babel-routes<0..*>;
-      [babel-mac-key-sets-obj   rw babel-mac-key-sets<0..*>;]
-      [babel-dtls-cert-sets-obj rw babel-dtls-cert-sets<0..*>;]
+       babel-interface-obj      ro babel-interfaces<0..*>;
+       babel-route-obj          ro babel-routes<0..*>;
+      [babel-mac-key-set-obj    rw babel-mac-key-sets<0..*>;]
+      [babel-dtls-cert-set-obj  rw babel-dtls-cert-sets<0..*>;]
    } babel-information-obj;
 ~~~~
 {: artwork-align="left"}
@@ -407,14 +407,14 @@ babel-routes:
   node.

 babel-mac-key-sets:
-: A babel-mac-key-sets-obj object. If this
+: A set of babel-mac-key-set-obj objects. If this
   object is implemented, it
   provides access to parameters related to the MAC security mechanism.
   An implementation MAY choose
   to expose this object as read-only ("ro").

 babel-dtls-cert-sets:
-: A babel-dtls-cert-sets-obj object. If this
+: A set of babel-dtls-cert-set-obj objects. If this
   object is implemented, it
   provides access to parameters related to the DTLS security mechanism.
   An implementation MAY choose
@@ -446,7 +446,7 @@ babel-mcast-group:
   to expose this parameter as read-only ("ro").


-## Definition of babel-interfaces-obj
+## Definition of babel-interface-obj


 ~~~~
@@ -468,8 +468,8 @@ babel-mcast-group:
       [boolean              rw babel-packet-log-enable;]
       [reference            ro babel-packet-log;]
       [babel-if-stats-obj   ro babel-if-stats;]
-       babel-neighbors-obj  ro babel-neighbors<0..*>;
-   } babel-interfaces-obj;
+       babel-neighbor-obj   ro babel-neighbors<0..*>;
+   } babel-interface-obj;
 ~~~~
 {: artwork-align="left"}

@@ -594,7 +594,7 @@ babel-if-stats:
 : Statistics collection object for this interface.

 babel-neighbors:
-: A set of babel-neighbors-obj objects.
+: A set of babel-neighbor-obj objects.


 ## Definition of babel-if-stats-obj
@@ -631,7 +631,7 @@ babel-received-packets:
 : A count of the number of Babel packets received on this interface.


-## Definition of babel-neighbors-obj
+## Definition of babel-neighbor-obj

 ~~~~
   object {
@@ -645,7 +645,7 @@ babel-received-packets:
       [uint                ro babel-ucast-hello-interval;]
       [uint                ro babel-rxcost;]
       [uint                ro babel-cost;]
-   } babel-neighbors-obj;
+   } babel-neighbor-obj;
 ~~~~
 {: artwork-align="left"}

@@ -727,7 +727,7 @@ babel-cost:
   This is a 16-bit unsigned integer.


-## Definition of babel-routes-obj
+## Definition of babel-route-obj

 ~~~~
   object {
@@ -741,7 +741,7 @@ babel-cost:
        ip-address           ro babel-route-next-hop;
        boolean              ro babel-route-feasible;
        boolean              ro babel-route-selected;
-   } babel-routes-obj;
+   } babel-route-obj;
 ~~~~
 {: artwork-align="left"}

@@ -808,13 +808,13 @@ babel-route-selected:
   is being advertised).


-## Definition of babel-mac-key-sets-obj
+## Definition of babel-mac-key-set-obj

 ~~~~
   object {
        boolean               rw babel-mac-default-apply;
-       babel-mac-keys-obj    rw babel-mac-keys<0..*>;
-   } babel-mac-obj;
+       babel-mac-key-obj     rw babel-mac-keys<0..*>;
+   } babel-mac-key-set-obj;
 ~~~~
 {: artwork-align="left"}

@@ -831,9 +831,9 @@ babel-mac-default-apply:
   to expose this parameter as read-only ("ro").

 babel-mac-keys:
-: A set of babel-mac-keys-obj objects.
+: A set of babel-mac-key-obj objects.

-## Definition of babel-mac-keys-obj
+## Definition of babel-mac-key-obj

 ~~~~
   object {
@@ -843,7 +843,7 @@ babel-mac-keys:
        binary                -- babel-mac-key-value;
        string                rw babel-mac-key-algorithm;
       [operation                babel-mac-key-test;]
-   } babel-mac-keys-obj;
+   } babel-mac-key-obj;
 ~~~~
 {: artwork-align="left"}

@@ -902,13 +902,13 @@ babel-mac-test:
   as a binary string.


-## Definition of babel-dtls-cert-sets-obj
+## Definition of babel-dtls-cert-set-obj

 ~~~~
   object {
        boolean               rw babel-dtls-default-apply;
-       babel-dtls-certs-obj  rw babel-dtls-certs<0..*>;
-   } babel-dtls-obj;
+       babel-dtls-cert-obj   rw babel-dtls-certs<0..*>;
+   } babel-dtls-cert-set-obj;
 ~~~~
 {: artwork-align="left"}

@@ -924,14 +924,14 @@ babel-dtls-default-apply:
   An implementation MAY choose
   to expose this parameter as read-only ("ro").

-babel-dtls-certs:
-: A set of babel-dtls-keys-obj objects. This contains both certificates
+babel-dtls-cert:
+: A set of babel-dtls-cert-obj objects. This contains both certificates
   for this implementation to present for authentication, and to accept
   from others. Certificates with a non-empty babel-cert-private-key can
   be presented by this implementation for authentication.


-## Definition of babel-dtls-certs-obj
+## Definition of babel-dtls-cert-obj

 ~~~~
   object {
@@ -940,7 +940,7 @@ babel-dtls-certs:
        string                rw babel-cert-type;
        binary                -- babel-cert-private-key;
       [operation                babel-cert-test;]
-   } babel-dtls-certs-obj;
+   } babel-dtls-cert-obj;
 ~~~~
 {: artwork-align="left"}

-- 
2.25.0