[yang-doctors] Yangdoctors early review of draft-ietf-babel-yang-model-03

Radek Krejčí via Datatracker <noreply@ietf.org> Mon, 14 October 2019 14:01 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: yang-doctors@ietf.org
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id 73D55120819; Mon, 14 Oct 2019 07:01:07 -0700 (PDT)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
From: =?utf-8?q?Radek_Krej=C4=8D=C3=AD_via_Datatracker?= <noreply@ietf.org>
To: <yang-doctors@ietf.org>
Cc: draft-ietf-babel-yang-model.all@ietf.org, babel@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 6.105.0
Auto-Submitted: auto-generated
Precedence: bulk
Reply-To: =?utf-8?b?UmFkZWsgS3JlasSNw60=?= <rkrejci@cesnet.cz>
Message-ID: <157106166738.24700.11185508261809138396@ietfa.amsl.com>
Date: Mon, 14 Oct 2019 07:01:07 -0700
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/Z5AeTtyaxHkv-Zl5mK2vE7Iba5w>
Subject: [yang-doctors] Yangdoctors early review of draft-ietf-babel-yang-model-03
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.29
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 14 Oct 2019 14:01:08 -0000

Reviewer: Radek Krejčí
Review result: Ready with Nits

There is a single module in the draft: ietf-babel@2019-08-22.yang.

There are 2 warnings reported by pyang 2.0.2, but both warnings seem to be
false.

ietf-babel@2019-08-22.yang:53: warning: RFC 8407: 3.1: The IETF Trust Copyright
statement seems to be missing (see pyang --ietf-help for details).
ietf-babel@2019-08-22.yang:208: warning: the module seems to use RFC 2119
keywords, but the required text from RFC 8174 is not found (see pyang
--ietf-help for details).

The draft is well written with an informative overview of the YANG module
sections. Maybe some set of example configuration data (some Appendix) would be
useful.

Regarding the YANG module, I have just a few notes:

- In multiple description texts, nodes are referenced by a path in format with
dashes (e.g. babel-mac-default-apply). This format is confusing especially when
some element in the path contains dash(es). Why the common format with slashes
is not used?

- Description and reference statements in containers and lists are placed as
the last statement (after children nodes). To increase readability and allow
people to decide if the content of the container/list is interesting for
detailed view, please move the descriptions / references to the beginning.

- grouping routes
  - just think if the grouping is reusable - in the module itself, the grouping
  is used just once and needless creation of groupings decrease module
  readability

- routes/routes/received-metric
  -  ... indicate a the route ... -> indicate the route ...

- babel/interfaces/metric-algorithm
  - the text "The value MUST be one of those listed in
  'metric-comp-algorithm'." in description just duplicates the type's
  information (identityref with metric-comp-algorithms base).

- babel/interfaces/mac-key-sets
  - what does the babel-mac-key-sets in description refer to?

- babel/interfaces/stats/reset
  - I'm confused, is it per-interface reset (as placed in the module) or
  system-wide interfaces stats reset (as information model defines it?). If it
  is the system-wide reset, why tha action cannot be placed in babel container?

- babel/mac/test/output/resulting-hash
  - according to the content, it seems to me that the description is actually
  the missing description of the test action.

- babel/dtls/test/output
  - seems to me more as a description of the action itself (where the
  description is missing)