Skip to content

Commit

Permalink
clean up draft (#1600)
Browse files Browse the repository at this point in the history
Co-authored-by: Scott Mansfield <[email protected]>
  • Loading branch information
samans and Scott Mansfield authored Dec 16, 2024
1 parent d2faa83 commit 0ab0c3b
Show file tree
Hide file tree
Showing 14 changed files with 68 additions and 69 deletions.
3 changes: 1 addition & 2 deletions standard/ieee/check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ cwd=$(pwd)
ietf_dir="standard/ietf"
ieee_dir="standard/ieee"

#draft/802.1/DC removed until fixed
to_check="draft/60802 draft/802.1/qrev draft/802.1/ASdm draft/802.1/ASdn draft/802.1/ASds draft/802.1/AXdz draft/802.1/Qdd draft/802.1/Qdx draft/802.1/Qdy draft/1588 draft/802 published/802 published/802.1 published/1588"
to_check="draft/60802 draft/802.1/qrev draft/802.1/ASds draft/802.1/AXdz draft/802.1/Qdd draft/802.1/Qdy draft/1588 draft/802 published/802 published/802.1 published/1588"

# relax constraint for now
# add --ietf if you want to do strict IETF checking
Expand Down
1 change: 0 additions & 1 deletion standard/ieee/draft/802.1/ASdm/check_pyang_extra_flags

This file was deleted.

1 change: 0 additions & 1 deletion standard/ieee/draft/802.1/ASds/check_pyang_extra_flags

This file was deleted.

1 change: 0 additions & 1 deletion standard/ieee/draft/802.1/DC/check_pyang_extra_flags

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module ieee802-dot1as-gptp {
Copyright (C) IEEE (2024). This version of this YANG module is part
of IEEE Std 802.1AS; see the standard itself for full legal notices.";
revision 2024-06-23 {
revision 2024-09-11 {
description
"Published as part of IEEE Std 802.1ASdn-2024. Initial version.";
reference
Expand Down Expand Up @@ -95,8 +95,8 @@ module ieee802-dot1as-gptp {
config false;
description
"The value is true if the time-aware system is capable of being a
grandmaster, and false if the time-aware system is not capable of
being a grandmaster.";
Grandmaster, and false if the time-aware system is not capable of
being a Grandmaster.";
reference
"14.2.7 of IEEE Std 802.1AS";
}
Expand Down Expand Up @@ -191,7 +191,7 @@ module ieee802-dot1as-gptp {
}
config false;
description
"The source of time used by the Grandmaster Clock This leaf
"The source of time used by the Grandmaster Clock. This leaf
applies to the ClockTimeTransmitter entity (i.e., local only,
unrelated to a remote GM).";
reference
Expand Down Expand Up @@ -623,7 +623,7 @@ module ieee802-dot1as-gptp {
description
"For an OLT port of an IEEE Std 802.3 EPON link, this value is
the effective index of refraction for the EPON upstream
wavelength light of the optical path";
wavelength light of the optical path.";
reference
"14.8.43 of IEEE Std 802.1AS";
}
Expand All @@ -632,7 +632,7 @@ module ieee802-dot1as-gptp {
description
"For an OLT port of an IEEE 802.3 EPON link, this value is the
effective index of refraction for the EPON downstream wavelength
light of the optical path";
light of the optical path.";
reference
"14.8.44 of IEEE Std 802.1AS";
}
Expand Down Expand Up @@ -1235,4 +1235,4 @@ module ieee802-dot1as-gptp {
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,27 @@ module ieee802-dot1as-hs {
E-mail: [email protected]";
description
"Management objects that control hot standby systems as
specified in IEEE Std 802.1ASdm.
specified in IEEE Std 802.1ASdm-2024.
References in this YANG module to IEEE Std 802.1AS are to
IEEE Std 802.1AS-2020 as modified by
IEEE Std 802.1AS-2020/Cor-1-2021, and amended by
IEEE Std 802.1ASdr, IEEE Std 802.1ASdn, and
IEEE Std 802.1ASdm.
IEEE Std 802.1ASdr-2024, IEEE Std 802.1ASdn-2024, and
IEEE Std 802.1ASdm-2024.
Copyright (C) IEEE (2024).
This version of this YANG module is part of IEEE Std 802.1AS;
see the standard itself for full legal notices.";

revision 2024-02-26 {
revision 2024-09-20 {
description
"Published as part of IEEE Std 802.1ASdm-2024.
Initial version.";
reference
"IEEE Std 802.1AS - YANG Data Model";
"IEEE Std 802.1AS - Timing and Synchronization for Time-Sensitive
Applications: IEEE Std 802.1AS-2020, IEEE Std 802.1AS-2020/Cor
1-2021, IEEE Std 802.1ASdr-2024, IEEE Std 802.1ASdn-2024,
IEEE Std 802.1ASdm-2024.";
}

feature hot-standby {
Expand Down Expand Up @@ -131,7 +134,7 @@ module ieee802-dot1as-hs {
ClockTarget whether a Grandmaster PTP Instance is
present.";
reference
"14.4.8 of IEEE Std 802.1AS";
"14.4.7a of IEEE Std 802.1AS";
}
}

Expand All @@ -143,14 +146,14 @@ module ieee802-dot1as-hs {
"The ptpInstanceSyncDS describes the synchronization status
of the PTP Instance.";
reference
"14.8 of IEEE Std 802.1AS";
"14.7a of IEEE Std 802.1AS";
leaf is-synced {
type boolean;
config false;
description
"The value of the global variable isSynced.";
reference
"14.8.2 of IEEE Std 802.1AS";
"14.7a.2 of IEEE Std 802.1AS";
}
leaf offset-from-time-transmitter-max {
type ptp-tt:time-interval;
Expand All @@ -159,7 +162,7 @@ module ieee802-dot1as-hs {
offsetFromTimeTransmitter, below which the PTP Instance
is considered to be synchronized.";
reference
"14.8.3 of IEEE Std 802.1AS";
"14.7a.3 of IEEE Std 802.1AS";
}
leaf rx-sync-count-time-receiver-p-thresh {
type uint32;
Expand All @@ -168,7 +171,7 @@ module ieee802-dot1as-hs {
threshold for rxSyncCountTimeReceiverP, above which
the PTP Instance is considered to be synchronized.";
reference
"14.8.4 of IEEE Std 802.1AS";
"14.7a.4 of IEEE Std 802.1AS";
}
leaf offset-max-exceeded-count-thresh {
type uint32;
Expand All @@ -179,7 +182,7 @@ module ieee802-dot1as-hs {
offsetFromTimeTransmitter, at which isSynced is no
longer TRUE.";
reference
"14.8.5 of IEEE Std 802.1AS";
"14.7a.5 of IEEE Std 802.1AS";
}
leaf offset-max-met-count-thresh {
type uint32;
Expand All @@ -190,22 +193,22 @@ module ieee802-dot1as-hs {
offsetFromTimeTransmitterMax, at which isSynced is
changed to TRUE if it currently is FALSE.";
reference
"14.8.6 of IEEE Std 802.1AS";
"14.7a.6 of IEEE Std 802.1AS";
}
}
container drift-tracking-ds {
description
"The driftTrackingDS contains a managed object that is used
to enable or disable the optional Drift_Tracking TLV.";
reference
"14.9 of IEEE Std 802.1AS";
"14.7b of IEEE Std 802.1AS";
leaf drift-tracking-tlv-support {
type boolean;
description
"The value of driftTrackingTlvSupport indicates whether
the Drift_Tracking TLV is enabled or disabled.";
reference
"14.9.2 of IEEE Std 802.1AS";
"14.7b.2 of IEEE Std 802.1AS";
}
}
}
Expand All @@ -221,7 +224,7 @@ module ieee802-dot1as-hs {
GptpCapableTransmit, GptpCapableReceive, and
GptpCapableIntervalSetting state machines.";
reference
"14.8.55 of IEEE Std 802.1AS";
"14.8.54a of IEEE Std 802.1AS";
}
leaf nrr-pdelay {
type int32;
Expand All @@ -233,9 +236,9 @@ module ieee802-dot1as-hs {
frequency of the LocalClock entity of this time-aware
system. nrrPdelay is expressed as the fractional frequency
offset stored in the global variable nrrPdelay multiplied
by 2^41, i.e., the quantity (nrrPdelay 1.0)(2^41).";
by 2^41, i.e., the quantity (nrrPdelay - 1.0)(2^41).";
reference
"14.8.56 of IEEE Std 802.1AS";
"14.8.54b of IEEE Std 802.1AS";
}
leaf nrr-sync {
type int32;
Expand All @@ -247,25 +250,25 @@ module ieee802-dot1as-hs {
frequency of the LocalClock entity of this time-aware
system. nrrSync is expressed as the fractional frequency
offset stored in the global variable nrrSync multiplied by
2^41, i.e., the quantity (nrrSync 1.0)(2^41).";
2^41, i.e., the quantity (nrrSync - 1.0)(2^41).";
reference
"14.8.57 of IEEE Std 802.1AS";
"14.8.54c of IEEE Std 802.1AS";
}
leaf nrr-comp-method {
type nrr-comp-method-type;
description
"An Enumeration that takes on the values sync and pdelay to
indicate the source of the value of neighborRateRatio.";
reference
"14.8.58 of IEEE Std 802.1AS";
"14.8.54d of IEEE Std 802.1AS";
}
leaf as-capable-across-domains {
type boolean;
description
"This leaf is true when this PTP port detects proper
exchange of Pdelay messages.";
reference
"14.8.59 of IEEE Std 802.1AS";
"14.8.54e of IEEE Std 802.1AS";
}
}

Expand All @@ -282,15 +285,15 @@ module ieee802-dot1as-hs {
information is received on a PTP Port when its port
state is TimeReceiverPort.";
reference
"14.10.20 of IEEE Std 802.1AS";
"14.10.19a of IEEE Std 802.1AS";
}
}

augment "/ptp-tt:ptp/ptp-tt:common-services" {
description
"Augment IEEE Std 1588 commonServices.
IEEE Std 802.1ASdm specifies nrrPdelay
IEEE Std 802.1ASdm-2024 specifies nrrPdelay
(nrr-pdelay), which is provided in YANG as the
semantically equivalent node in ieee1588-ptp-tt named
scaled-neighbor-rate-ratio (in link-port-ds).";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ module ieee802-dot1dc-ats-if {
E-mail: [email protected]";

description
"This module provides management of 802.1Q General Frame Quality of
"This module provides management of General Frame Quality of
Service (GFQoS) systems that support Asynchronous Traffic Shaping
(ATS).
Expand All @@ -40,16 +40,16 @@ module ieee802-dot1dc-ats-if {
This version of this YANG module is part of IEEE Std 802.1DC;
see the standard itself for full legal notices.";

revision 2024-02-28 {
revision 2024-09-26 {
description
"Published as part of IEEE Std 802.1DC.
"Published as part of IEEE Std 802.1DC-2024.
The following reference statement identifies each referenced
IEEE Standard as updated by applicable amendments.";

reference
"IEEE Std 802.1DC:
IEEE Std 802.1DC - Quality of Service Provision by
IEEE Std 802.1DC-2024 Quality of Service Provision by
Network Systems.";
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,31 @@ module ieee802-dot1dc-cbsa-if {

description
"This module provides for management of General Frame Quality of
Service (GFQoS) systems that support the Credit-Based Shaper
Service (GFQoS) systems that support the credit-based shaper
transmission selection algorithm.
Copyright (C) IEEE (2024).
This version of this YANG module is part of IEEE Std 802.1DC;
see the standard itself for full legal notices.";

revision 2024-07-15 {
revision 2024-09-26 {
description
"Published as part of IEEE Std 802.1DC.
"Published as part of IEEE Std 802.1DC-2024.
The following reference statement identifies each referenced
IEEE Standard as updated by applicable amendments.";

reference
"IEEE Std 802.1DC:
IEEE Std 802.1DC - Quality of Service Provision by
IEEE Std 802.1DC-2024 Quality of Service Provision by
Network Systems.";
}

augment "/if:interfaces/if:interface" {

description
"Augment interface with Credit-Based Shaper configuration.";
"Augment interface with credit-based shaper configuration.";

uses cbsa:cbsa-parameters;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module ieee802-dot1dc-gfqos {

description
"This module provides for management of General Frame Quality of
Service (GFQoS) systems that support Extended Internal Sublayer
Service (GFQoS) systems that support the Enhanced Internal Sublayer
Service (EISS).
Expand All @@ -41,24 +41,24 @@ module ieee802-dot1dc-gfqos {
This version of this YANG module is part of IEEE Std 802.1DC;
see the standard itself for full legal notices.";

revision 2024-02-28 {
revision 2024-09-26 {
description
"Published as part of IEEE Std 802.1DC.
"Published as part of IEEE Std 802.1DC-2024.
The following reference statement identifies each referenced
IEEE Standard as updated by applicable amendments.";

reference
"IEEE Std 802.1DC:
IEEE Std 802.1DC - Quality of Service Provision by Network
IEEE Std 802.1DC-2024 Quality of Service Provision by Network
Systems.
IEEE Std 802.1Q:
IEEE Std 802.1Q-2022 Bridges and Bridged Networks.";
}

feature eiss {
description
"Each GFQoS interface may support the Extended Internal Sublayer
"Each GFQoS interface may support the Enhanced Internal Sublayer
Service (EISS). This is one useful method for dealing with VLAN
tags.";
reference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,23 @@ module ieee802-dot1dc-preemption-if {

description
"This module provides for management of General Frame Quality of
Service (GFQoS) systems that support Frame Preemption.
Service (GFQoS) systems that support frame preemption.
Copyright (C) IEEE (2024).
This version of this YANG module is part of IEEE Std 802.1DC;
see the standard itself for full legal notices.";

revision 2024-02-28 {
revision 2024-09-26 {
description
"Published as part of IEEE Std 802.1DC.
"Published as part of IEEE Std 802.1DC-2024.
The following reference statement identifies each referenced
IEEE Standard as updated by applicable amendments.";

reference
"IEEE Std 802.1DC:
IEEE Std 802.1DC - Quality of Service Provision by
IEEE Std 802.1DC-2024 Quality of Service Provision by
Network Systems.";
}

Expand All @@ -56,7 +56,7 @@ module ieee802-dot1dc-preemption-if {
augment "/if:interfaces/if:interface" {
if-feature "frame-preemption";
description
"Augment interface with Frame Preemption configuration.";
"Augment interface with frame preemption configuration.";
uses q-preempt:preemption-parameters;
}
}
Loading

0 comments on commit 0ab0c3b

Please sign in to comment.