Re: [lp-wan] AD review of draft-ietf-lpwan-schc-yang-data-model-12

Laurent Toutain <laurent.toutain@imt-atlantique.fr> Mon, 30 May 2022 17:32 UTC

Return-Path: <laurent.toutain@imt-atlantique.fr>
X-Original-To: lp-wan@ietfa.amsl.com
Delivered-To: lp-wan@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 5F6DCC15AAF5 for <lp-wan@ietfa.amsl.com>; Mon, 30 May 2022 10:32:47 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.105
X-Spam-Level:
X-Spam-Status: No, score=-2.105 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=unavailable autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=imt-atlantique.fr
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id rE7g1HvBHb5W for <lp-wan@ietfa.amsl.com>; Mon, 30 May 2022 10:32:43 -0700 (PDT)
Received: from zproxy130.enst.fr (zproxy130.enst.fr [IPv6:2001:660:330f:2::c2]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 443F1C15AAE5 for <lp-wan@ietf.org>; Mon, 30 May 2022 10:32:42 -0700 (PDT)
Received: from localhost (localhost [IPv6:::1]) by zproxy130.enst.fr (Postfix) with ESMTP id 8AB881205E5 for <lp-wan@ietf.org>; Mon, 30 May 2022 19:32:32 +0200 (CEST)
Received: from zproxy130.enst.fr ([IPv6:::1]) by localhost (zproxy130.enst.fr [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id m8DEWSxSn6Fa for <lp-wan@ietf.org>; Mon, 30 May 2022 19:32:31 +0200 (CEST)
Received: from localhost (localhost [IPv6:::1]) by zproxy130.enst.fr (Postfix) with ESMTP id 494001205F1 for <lp-wan@ietf.org>; Mon, 30 May 2022 19:32:31 +0200 (CEST)
DKIM-Filter: OpenDKIM Filter v2.10.3 zproxy130.enst.fr 494001205F1
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=imt-atlantique.fr; s=50EA75E8-DE22-11E6-A6DE-0662BA474D24; t=1653931951; bh=uj9CVKQviyy3g4j8Q64pAhFwj34RFXfzjoxovQ7785c=; h=MIME-Version:From:Date:Message-ID:To; b=RtK8SxVcED4fMahxNrIw8UxvO4GtpbkgSZMIf287WZ25TuPqOrROkQjaqsW6N8Wob e4eBAiI58YIiMbVwh2Qkwf82xdjD6Das0wNoquz2OeixnfIRVWIyKbPkWyJNXZQ1NX 5GC6XWQWlhBPZtA3LyQTBjkcEWZsM/ylOuxOY5Gk=
X-Virus-Scanned: amavisd-new at zproxy130.enst.fr
Received: from zproxy130.enst.fr ([IPv6:::1]) by localhost (zproxy130.enst.fr [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id 7ylHZspJ0Th6 for <lp-wan@ietf.org>; Mon, 30 May 2022 19:32:31 +0200 (CEST)
Received: from mail-qt1-f174.google.com (mail-qt1-f174.google.com [209.85.160.174]) by zproxy130.enst.fr (Postfix) with ESMTPSA id 1AF501205E5 for <lp-wan@ietf.org>; Mon, 30 May 2022 19:32:31 +0200 (CEST)
Received: by mail-qt1-f174.google.com with SMTP id f35so11788790qtb.11 for <lp-wan@ietf.org>; Mon, 30 May 2022 10:32:31 -0700 (PDT)
X-Gm-Message-State: AOAM532ZSpSlt3hEqYRtLvLUyKhRNIuRgcYruECole61UF5RzupyYTgo QKxz3WYbAQ/4F1kcSzMJPRMQVr5baaniS9LALqg=
X-Google-Smtp-Source: ABdhPJwiYdtUOAUR/ag+aie/m/SUFMmUxWXwHJo3T6sChk1rnwY7py44bX9sxBPGZ6qu50Gfp5VxXHa1rlAI507AuPw=
X-Received: by 2002:a05:622a:508:b0:2f9:1cc0:2d50 with SMTP id l8-20020a05622a050800b002f91cc02d50mr40140833qtx.66.1653931949972; Mon, 30 May 2022 10:32:29 -0700 (PDT)
MIME-Version: 1.0
References: <5FDAEB7A-758D-404E-B572-56DCEA504E0F@cisco.com>
In-Reply-To: <5FDAEB7A-758D-404E-B572-56DCEA504E0F@cisco.com>
From: Laurent Toutain <laurent.toutain@imt-atlantique.fr>
Date: Mon, 30 May 2022 19:31:53 +0200
X-Gmail-Original-Message-ID: <CABONVQbb8hdiU2Ef6uzkPRFeBHhsd0844-jQe2V9iUZ0JNHG+A@mail.gmail.com>
Message-ID: <CABONVQbb8hdiU2Ef6uzkPRFeBHhsd0844-jQe2V9iUZ0JNHG+A@mail.gmail.com>
To: "Eric Vyncke (evyncke)" <evyncke=40cisco.com@dmarc.ietf.org>
Cc: "lp-wan@ietf.org" <lp-wan@ietf.org>
Content-Type: multipart/alternative; boundary="0000000000005c620d05e03e0a3e"
Archived-At: <https://mailarchive.ietf.org/arch/msg/lp-wan/1r8SZN2MTHHxV_sNPhejnOtL3rI>
Subject: Re: [lp-wan] AD review of draft-ietf-lpwan-schc-yang-data-model-12
X-BeenThere: lp-wan@ietf.org
X-Mailman-Version: 2.1.34
Precedence: list
List-Id: "Low-Power Wide Area Networking \(LP-WAN\), also known as LPWA or Low-Rate WAN \(LR-WAN\)" <lp-wan.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/lp-wan>, <mailto:lp-wan-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/lp-wan/>
List-Post: <mailto:lp-wan@ietf.org>
List-Help: <mailto:lp-wan-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/lp-wan>, <mailto:lp-wan-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 30 May 2022 17:32:47 -0000

Thank you very much Eric for your comments.

I haven't issued a -13 since some comments such as the security section
requires more work, but I pushed the editorial corrections in the repo.

There is two comments I would like to discuss in the list, before editing.

The first one is about the conversion between string and binary. That's a
very good point. Currently it happens only for string fields such ad
Uri-path and Uri-query in CoAP, RFC 7252 gives this definition of strings:

 string:   A Unicode string that is encoded using UTF-8 [RFC3629
<https://datatracker.ietf.org/doc/html/rfc3629>] in
             Net-Unicode form [RFC5198
<https://datatracker.ietf.org/doc/html/rfc5198>].


we can keep the same definition and say that the Target Value is the
binary representation of this. But we may image other protocols that uses
another coding, is it out of the scope of the YANG data model or we try to
have a phrasing to include them ?


The second point is also raised by Tom in his review. "all1" term appears
ambiguous because l and 1 are confusing. May be we can write them in
capital in the model ALL1 ALL0 to limit the ambiguities ?

Laurent

On Mon, May 30, 2022 at 10:09 AM Eric Vyncke (evyncke) <evyncke=
40cisco.com@dmarc.ietf.org> wrote:

> Dear Ana and Laurent,
>
> Please find below a list of points raised during my AD review. I would
> appreciate a reply on all of them; the reply could vary from “we ignore
> because of foo” to “this will be fixed in -13”.
>
> I have also attached your I-D formatted as a MS-Word document to allow you
> to chase all typos and grammar errors.
>
> Thanks again for your work, YANG models are never a fun task to do.
>
> Regards
>
> -éric
>
> # Sect #
>
> no need for capitalized “Destination address”
>
> # Sect 2
>
>  *blocking* please use the right template from BCP14
>
> #Sect 3
>
> no need to repeat the introduction text from sect 1
>
> # Section 3.2
>
> no need to capitalize “Data Model”
>
> please expand “RCS” at first use
>
> # Sect 3.3
>
> use either “YANG data model” or “YANG module” but not “YANG model”
>
> s/always derives/is always derived/ ? (Passive voice)
>
> s/MUST derive/MUST be derived/ ?
>
> Suggest renaming the section into “Conventions for Field Identifiers”
>
> # Sect 3.4
>
> Please do not capitalize “byte” (and you may want to use the plural form)
>
> # Sect 3.7
>
> Please expand “CDA”
>
> Unsure whether “strings must be converted to binary” is non-ambiguous. How
> can it be done ? Should there be a reference ?
>
> # Sec 3.9
>
> s/ shows some CDA definition/ shows some CDA definitions/
>
> # Sec 3.10.2
>
> It should be clear for the reader that this text is coming out of RFC 8724
> and not specified by this I-D.
>
> # Sec 3.10.3
>
> Suggest to add somewhere that "all1" is lower case "ALL" followed by
> figure "1".
>
> # Sec 3.10.4
>
> It should be clear for the reader that this text is coming out of RFC 8724
> and not specified by this I-D.
>
> Why "All1" (capitalized) while previously "all1" (lowercase) was used ?
>
> # Sec 3.10.5
>
> "rexpresses" ?
>
> # Sec 3.10.6
>
> Should the text be clear that l2-word-size is expressed in bits ?
>
> # Sec 4.2
>
> s/milli-seconds for real time/milliseconds for real-time/
>
> s/micro-second/microsecond/
>
> s/ computed through/ computed by/ ?
>
> An RFC must be accurate, so text like "of about 1.05 second" is not
> suitable. If it is about 2**20 microseconds, then be explicit.
>
> # Section 5
>
> Thanks for including this section. But, per RFC 7942 section 2.1, a note
> to the RFC editor must be included to remove this section before
> publication.
>
> # Section 6
>
> I am afraid that there must be some IANA considerations for each and every
> YANG module, e.g., see
> https://datatracker.ietf.org/doc/html/draft-ietf-dhc-dhcpv6-yang-25#section-6
>
> # Section 7
>
> Please use the YANG security template:
> https://trac.ietf.org/trac/ops/wiki/yang-security-guidelines
>
> # Section 9
>
> The location of the YANG module is unusual, it should come before the
> "implementation status".
>
> s/code begins/CODE BEGINS/ same for ends of course __
>
> Please put "" around the filename.
>
>
> _______________________________________________
> lp-wan mailing list
> lp-wan@ietf.org
> https://www.ietf.org/mailman/listinfo/lp-wan
>