Re: [netmod] WGLC for draft-ietf-tictoc-1588v2-yang

[Rodney Cummings <[e-mail]>]

Thanks Alex,

Good feedback.

As an overall point, most of these names have a 1-1 association to a name from the IEEE Std 1588-2008 standard. The 1588 document uses "DS" as an abbreviation for its "data set", which is essentially an information model for a collection of nodes. Beyond that, 1588 uses camel-case for its names, such as:
	DefaultDS.numberPorts
The co-authors of this I-D used the following approach:
	Change names to the typical YANG convention (lowercase dashed), but otherwise strive to keep the 1-1 relationship with the 1588 name.
We were trying to avoid someone getting confused, and thinking that the YANG name is something new, not specified in 1588.
This means that you will see names like:
	default-ds.number-ports
I'd prefer to avoid changing to "number-of-ports", because for whatever reason, 1588 uses numberPorts, and it'd be best to keep the 1-1 relationship.

Other than that, all of your comments seem fine with me.

Rodney

> -----Original Message-----
> From: TICTOC [mailto:[e-mail]] On Behalf Of Alex Campbell
> Sent: Friday, September 15, 2017 12:27 AM
> To: Jiangyuanlong <[e-mail]>; [e-mail]
> Cc: [e-mail]
> Subject: Re: [TICTOC] WGLC for draft-ietf-tictoc-1588v2-yang
> 
> Hi,
> I've reviewed the draft and found the following issues.
> 
> * YANG enumeration values are conventionally lowercase, but the delay-
> mechanism-enumeration and port-state-enumeration types in the draft have
> uppercase values.
> * Similarly, hyphens should be used rather than underscores (pre-master
> instead of PRE_MASTER)
> * number-ports doesn't read naturally in English; I suggest renaming it to
> number-of-ports.
> * The description of port-ds-list contains a typo - "memer" instead of
> "member".
> * There's no need to have groupings that are only used once (such as
> parent-ds-entry, current-ds-entry, default-ds-entry, transparent-clock-
> default-ds-entry, port-ds-entry, transparent-clock-default-ds-entry, and
> so on) unless this is for futureproofing or some other reason I'm not
> aware of.
> * Is it necessary to include -ds in the name of every leaf, container and
> grouping?
> 
> Note I'm not familiar with IEEE 1588, apart from a brief look through it
> just now.
> 
> Alex
> 
> 
> ________________________________________
> From: netmod <[e-mail]> on behalf of Jiangyuanlong
> <[e-mail]>
> Sent: Friday, 15 September 2017 1:42 p.m.
> To: [e-mail]
> Cc: [e-mail]
> Subject: [netmod] FW: WGLC for draft-ietf-tictoc-1588v2-yang
> 
> Hi netmoders,
> 
> This draft does not tackle the general YANG problem, but provide a generic
> time synchronization module of 1588.
> Some of you may have interests in time synchronization, some definitely
> not. But as experts in YANG, could you please have a review of this YANG
> module and give an expert opinion?
> 
> Thanks,
> Yuanlong
> 
> -----Original Message-----
> From: TICTOC [mailto:[e-mail]] On Behalf Of Karen
> O'Donoghue
> Sent: Thursday, September 14, 2017 3:16 AM
> To: [e-mail]
> Cc: [e-mail]
> Subject: [TICTOC] WGLC for draft-ietf-tictoc-1588v2-yang
> 
> Folks,
> 
> This message begins a 2 week working group last call (WGLC) for the
> following document:
> 
> YANG Data Model for IEEE 1588v2
> https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__datatracker.ietf.org_doc_draft-2Dietf-2Dtictoc-2D1588v2-
> 2Dyang_&d=DwICAg&c=I_0YwoKy7z5LMTVdyO6YCiE2uzI1jjZZuIPelcSjixA&r=WA71sf2o7
> Dw7CbYhFt24DPjt3lJuupswWYdnboKbZ8k&m=KYy1NqCkT9fELXGg7ARrUez4toujzAfPIBGxu
> 4O-IwA&s=JeFM02MFCMdOI1qLRL6vF-Db7NDdjIn4sLd9_HuDPio&e=
> 
> Please review the referenced document and send any comments to the mailing
> list including your assessment of whether this document is mature enough
> to proceed to the IESG. Please note that these messages of support for
> progression to the mailing list are important and will be used to
> determine WG consensus to proceed.
> 
> Please send all comments in by Thursday 28 September 2017.
> 
> Thank you!
> Karen
> _______________________________________________
> TICTOC mailing list
> [e-mail]
> https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__www.ietf.org_mailman_listinfo_tictoc&d=DwICAg&c=I_0YwoKy7z5LMTVdyO6YCi
> E2uzI1jjZZuIPelcSjixA&r=WA71sf2o7Dw7CbYhFt24DPjt3lJuupswWYdnboKbZ8k&m=KYy1
> NqCkT9fELXGg7ARrUez4toujzAfPIBGxu4O-
> IwA&s=zEhnTQKhHxNWCB1MNgv1Oulcl78Y4yP3S5Zfb7m9dPY&e=
> 
> _______________________________________________
> netmod mailing list
> [e-mail]
> https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__www.ietf.org_mailman_listinfo_netmod&d=DwICAg&c=I_0YwoKy7z5LMTVdyO6YCi
> E2uzI1jjZZuIPelcSjixA&r=WA71sf2o7Dw7CbYhFt24DPjt3lJuupswWYdnboKbZ8k&m=KYy1
> NqCkT9fELXGg7ARrUez4toujzAfPIBGxu4O-IwA&s=cEawQxd1IoW8ewaY4Q822u-
> yKPhzvQSiK12nIyg39cA&e=
> 
> _______________________________________________
> TICTOC mailing list
> [e-mail]
> https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__www.ietf.org_mailman_listinfo_tictoc&d=DwICAg&c=I_0YwoKy7z5LMTVdyO6YCi
> E2uzI1jjZZuIPelcSjixA&r=WA71sf2o7Dw7CbYhFt24DPjt3lJuupswWYdnboKbZ8k&m=KYy1
> NqCkT9fELXGg7ARrUez4toujzAfPIBGxu4O-
> IwA&s=zEhnTQKhHxNWCB1MNgv1Oulcl78Y4yP3S5Zfb7m9dPY&e=