Skip to content

Commit

Permalink
Script updating gh-pages from 949184d. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
ID Bot committed Oct 25, 2023
1 parent 6618772 commit dc1d4d7
Show file tree
Hide file tree
Showing 3 changed files with 96 additions and 91 deletions.
29 changes: 17 additions & 12 deletions draft-ietf-cbor-time-tag.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1590,14 +1590,17 @@ <h3 id="name-key-1-timescale">
</pre><a href="#section-3.4-2" class="pilcrow"></a>
</div>
<p id="section-3.4-3">If key -1 is not present, the default timescale value 0 is implied.<a href="#section-3.4-3" class="pilcrow"></a></p>
<p id="section-3.4-4">Additional values can be registered in the Timescale Registry
(<a href="#timescale-registry" class="auto internal xref">Section 7.2</a>); values <span class="bcp14">MUST</span> be integers or text strings.<a href="#section-3.4-4" class="pilcrow"></a></p>
<p id="section-3.4-5">(Note that there should be no timescales "GPS" or "NTP" <span>[<a href="#RFC5905" class="cite xref">RFC5905</a>]</span> — instead,
the time should be converted to TAI or UTC using a single addition or subtraction.)<a href="#section-3.4-5" class="pilcrow"></a></p>
<p id="section-3.4-4">Timescale values <span class="bcp14">MUST</span> be unsigned integers or text strings; text strings are
provided for experimentation and <span class="bcp14">MUST NOT</span> be used between parties
which are not both part of the experiment.
Additional unsigned integer values can be registered in the Timescale Registry
(<a href="#timescale-registry" class="auto internal xref">Section 7.2</a>).
(Note that there should be no timescales "GPS" or "NTP" <span>[<a href="#RFC5905" class="cite xref">RFC5905</a>]</span> — instead,
the time should be converted to TAI or UTC using a single addition or subtraction.)<a href="#section-3.4-4" class="pilcrow"></a></p>
<span id="name-converting-common-offset-ti"></span><div id="offset">
<figure id="figure-2">
<div id="section-3.4-6.1">
<div class="alignLeft art-svg artwork" id="section-3.4-6.1.1">
<div id="section-3.4-5.1">
<div class="alignLeft art-svg artwork" id="section-3.4-5.1.1">
<svg xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" height="6.009ex" role="img" viewBox="0 -791.3 43055.4 2587.3" width="100ex">
<defs>
<path d="M283 438l-10 -38h-70l-78 -320c-1 -3 -2 -8 -2 -11c0 -6 3 -12 16 -12c0 0 23 2 60 52l13 -11c-24 -31 -74 -107 -133 -107c-31 0 -39 25 -39 52c0 13 2 26 5 37l81 320h-77l5 29c75 14 136 51 177 138h13l-31 -129h70Z" id="E1-STIXWEBNORMALI-1D461-gensym001" stroke-width="1"></path>
Expand Down Expand Up @@ -1683,15 +1686,15 @@ <h3 id="name-key-1-timescale">
</g>
</g>
</g>
</svg><a href="#section-3.4-6.1.1" class="pilcrow"></a>
</svg><a href="#section-3.4-5.1.1" class="pilcrow"></a>
</div>
</div>
<figcaption><a href="#figure-2" class="selfRef">Figure 2</a>:
<a href="#name-converting-common-offset-ti" class="selfRef">Converting Common Offset Timescales</a>
</figcaption></figure>
</div>
<aside id="section-3.4-7">
<p id="section-3.4-7.1">Editor's note:
<aside id="section-3.4-6">
<p id="section-3.4-6.1">Editor's note:
This initial set of timescales was deliberately chosen to be frugal, as
the specification of the tag provides an extension point where
additional timescales can be registered at any time.
Expand All @@ -1701,7 +1704,7 @@ <h3 id="name-key-1-timescale">
constant offset basis for GPS times).
While the registration process itself is trivial, these registrations
need to be made based on a solid specification of their actual
definition.<a href="#section-3.4-7.1" class="pilcrow"></a></p>
definition.<a href="#section-3.4-6.1" class="pilcrow"></a></p>
</aside>
</section>
</div>
Expand Down Expand Up @@ -2178,7 +2181,8 @@ <h3 id="name-timescale-registry">
and "RFC Required" as the Registration Procedure (Sections <a href="https://rfc-editor.org/rfc/rfc8126#section-4.5" class="relref">4.5</a> and <a href="https://rfc-editor.org/rfc/rfc8126#section-4.7" class="relref">4.7</a> of <span>[<a href="#BCP26" class="cite xref">BCP26</a>]</span>).<a href="#section-7.2-1" class="pilcrow"></a></p>
<p id="section-7.2-2">Each entry needs to provide a timescale name (a sequence of uppercase
ASCII characters and digits, where a digit may not occur at the start:
<code>[A-Z][A-Z0-9]*</code>), a value (CBOR unsigned integer, uint), and brief description
<code>[A-Z][A-Z0-9]*</code>), a value (CBOR unsigned integer, uint,
0..18446744073709551615), a brief description
of the semantics, and a specification reference (RFC).
The initial contents are shown in <a href="#tab-timescales" class="auto internal xref">Table 3</a>.<a href="#section-7.2-2" class="pilcrow"></a></p>
<span id="name-initial-content-of-timescal"></span><div id="tab-timescales">
Expand Down Expand Up @@ -2224,7 +2228,8 @@ <h3 id="name-time-tag-map-key-registry">
<p id="section-7.3-2">The designated expert is requested to assign the key values with the
shortest encodings (1+0 and 1+1 encoding) to registrations that are
likely to enjoy wide use and can benefit from short encodings.<a href="#section-7.3-2" class="pilcrow"></a></p>
<p id="section-7.3-3">Each entry needs to provide a map key value (CBOR integer, int), a brief description
<p id="section-7.3-3">Each entry needs to provide a map key value (CBOR integer, int,
-18446744073709551616..18446744073709551615), a brief description
of the semantics, and a specification reference.
Note that negative integers indicate an elective key, while unsigned
integers indicate a key that either provides a base time or is
Expand Down
126 changes: 63 additions & 63 deletions draft-ietf-cbor-time-tag.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Table of Contents
3.5.1. ClockClass (Key -2) . . . . . . . . . . . . . . . . . 9
3.5.2. ClockAccuracy (Key -4) . . . . . . . . . . . . . . . 9
3.5.3. OffsetScaledLogVariance (Key -5) . . . . . . . . . . 9
3.5.4. Uncertainty (Key -7) . . . . . . . . . . . . . . . . 9
3.5.4. Uncertainty (Key -7) . . . . . . . . . . . . . . . . 10
3.5.5. Guarantee (Key -8) . . . . . . . . . . . . . . . . . 10
3.6. Keys -10, 10: Time Zone Hint . . . . . . . . . . . . . . 11

Expand Down Expand Up @@ -408,12 +408,13 @@ Internet-Draft CBOR tag for extended time October 2023

If key -1 is not present, the default timescale value 0 is implied.

Additional values can be registered in the Timescale Registry
(Section 7.2); values MUST be integers or text strings.

(Note that there should be no timescales "GPS" or "NTP" [RFC5905] —
instead, the time should be converted to TAI or UTC using a single
addition or subtraction.)
Timescale values MUST be unsigned integers or text strings; text
strings are provided for experimentation and MUST NOT be used between
parties which are not both part of the experiment. Additional
unsigned integer values can be registered in the Timescale Registry
(Section 7.2). (Note that there should be no timescales "GPS" or
"NTP" [RFC5905] — instead, the time should be converted to TAI or UTC
using a single addition or subtraction.)

t = t - 2208988800
utc ntp
Expand All @@ -439,9 +440,8 @@ Internet-Draft CBOR tag for extended time October 2023
A number of keys are defined to indicate the quality of clock that
was used to determine the point in time.

The first three are analogous to clock-quality-grouping in [RFC8575],
which is in turn based on the definitions in [IEEE1588-2008]; the
last two are specific to this document.





Expand All @@ -450,6 +450,10 @@ Bormann, et al. Expires 27 April 2024 [Page 8]
Internet-Draft CBOR tag for extended time October 2023


The first three are analogous to clock-quality-grouping in [RFC8575],
which is in turn based on the definitions in [IEEE1588-2008]; the
last two are specific to this document.

ClockQuality-group = (
? &(ClockClass: -2) => uint .size 1 ; PTP/RFC8575
? &(ClockAccuracy: -4) => uint .size 1 ; PTP/RFC8575
Expand Down Expand Up @@ -493,11 +497,7 @@ Internet-Draft CBOR tag for extended time October 2023
this characteristic are defined in Section 7.6.3 of [IEEE1588-2019]
and the same section in [IEEE1588-2008].

3.5.4. Uncertainty (Key -7)

Key -7 (Uncertainty) can be used to represent a known measurement
uncertainty for the clock, as a numeric value in seconds or as a
duration (Section 4).



Expand All @@ -506,6 +506,12 @@ Bormann, et al. Expires 27 April 2024 [Page 9]
Internet-Draft CBOR tag for extended time October 2023


3.5.4. Uncertainty (Key -7)

Key -7 (Uncertainty) can be used to represent a known measurement
uncertainty for the clock, as a numeric value in seconds or as a
duration (Section 4).

For this document, uncertainty is defined as in Section 2.2.3 of
[GUM]: "parameter, associated with the result of a measurement, that
characterizes the dispersion of the values that could reasonably be
Expand Down Expand Up @@ -548,12 +554,6 @@ Internet-Draft CBOR tag for extended time October 2023
Note that the additional information that can be meaningfully
provided with the duration that represents a guarantee is limited,
e.g., it is not meaningful to provide a guarantee of accuracy for the
duration representing a guarantee of accuracy. Implementations are
free to reduce a guarantee (which is already elective) to the
information they can process.






Expand All @@ -562,6 +562,10 @@ Bormann, et al. Expires 27 April 2024 [Page 10]
Internet-Draft CBOR tag for extended time October 2023


duration representing a guarantee of accuracy. Implementations are
free to reduce a guarantee (which is already elective) to the
information they can process.

3.6. Keys -10, 10: Time Zone Hint

Keys -10 and 10 supply supplementary information, where key 10 is
Expand Down Expand Up @@ -602,12 +606,8 @@ Internet-Draft CBOR tag for extended time October 2023
Keys -11 and 11 supply supplementary information, where key 11 is
critical.

Similar to keys -10 and 10, keys -11 (elective) and 11 (critical) can
be used to provide additional information in the style of IXDTF
suffixes, such as the calendar that would best fit for displaying the
time given to humans. The key's value is a map that has IXDTF
suffix-key names as keys and corresponding suffix values as values,
specifically:





Expand All @@ -618,6 +618,13 @@ Bormann, et al. Expires 27 April 2024 [Page 11]
Internet-Draft CBOR tag for extended time October 2023


Similar to keys -10 and 10, keys -11 (elective) and 11 (critical) can
be used to provide additional information in the style of IXDTF
suffixes, such as the calendar that would best fit for displaying the
time given to humans. The key's value is a map that has IXDTF
suffix-key names as keys and corresponding suffix values as values,
specifically:

$$ETIME-ELECTIVE //= (-11: suffix-info-map)
$$ETIME-CRITICAL //= (11: suffix-info-map)

Expand Down Expand Up @@ -659,13 +666,6 @@ Internet-Draft CBOR tag for extended time October 2023
Note that both -10 and -11 are using negative keys and therefore
provide elective information, as in the IXDTF form given in the
comment. Note also that in this example the time numeric offset
(-08:00) is lost in translating from the [RFC3339] information in the
IXDTF into a POSIX time that can be included under Key 1 in a time
tag.







Expand All @@ -674,6 +674,10 @@ Bormann, et al. Expires 27 April 2024 [Page 12]
Internet-Draft CBOR tag for extended time October 2023


(-08:00) is lost in translating from the [RFC3339] information in the
IXDTF into a POSIX time that can be included under Key 1 in a time
tag.

4. Duration Format

A duration is the length of an interval of time. Durations in this
Expand Down Expand Up @@ -716,11 +720,7 @@ Internet-Draft CBOR tag for extended time October 2023
They are given as an array of unwrapped time and duration elements,
tagged with Tag 1003:

Period = #6.1003([
start: ~Etime / null
end: ~Etime / null
? duration: ~Duration / null
])




Expand All @@ -730,6 +730,12 @@ Bormann, et al. Expires 27 April 2024 [Page 13]
Internet-Draft CBOR tag for extended time October 2023


Period = #6.1003([
start: ~Etime / null
end: ~Etime / null
? duration: ~Duration / null
])

If the third array element is not given, the duration element is
null. Exactly two out of the three elements must be non-null, this
can be somewhat verbosely expressed in CDDL as:
Expand Down Expand Up @@ -775,12 +781,6 @@ Internet-Draft CBOR tag for extended time October 2023









Bormann, et al. Expires 27 April 2024 [Page 14]

Internet-Draft CBOR tag for extended time October 2023
Expand Down Expand Up @@ -810,9 +810,10 @@ Internet-Draft CBOR tag for extended time October 2023

Each entry needs to provide a timescale name (a sequence of uppercase
ASCII characters and digits, where a digit may not occur at the
start: [A-Z][A-Z0-9]*), a value (CBOR unsigned integer, uint), and
brief description of the semantics, and a specification reference
(RFC). The initial contents are shown in Table 3.
start: [A-Z][A-Z0-9]*), a value (CBOR unsigned integer, uint,
0..18446744073709551615), a brief description of the semantics, and a
specification reference (RFC). The initial contents are shown in
Table 3.

+===========+=======+======================+===========+
| Timescale | Value | Semantics | Reference |
Expand All @@ -831,9 +832,8 @@ Internet-Draft CBOR tag for extended time October 2023
"Specification Required" as the Registration Procedure (Section 4.6
of [BCP26]).

The designated expert is requested to assign the key values with the
shortest encodings (1+0 and 1+1 encoding) to registrations that are
likely to enjoy wide use and can benefit from short encodings.





Expand All @@ -842,21 +842,21 @@ Bormann, et al. Expires 27 April 2024 [Page 15]
Internet-Draft CBOR tag for extended time October 2023


Each entry needs to provide a map key value (CBOR integer, int), a
brief description of the semantics, and a specification reference.
Note that negative integers indicate an elective key, while unsigned
integers indicate a key that either provides a base time or is
critical. For the unsigned integers as keys, the choice of base time
or critical needs to be indicated in the brief semantics description.
(Elective map keys may be explicitly marked as such in the
description, e.g., to distinguish them from critical keys.)

The initial contents are shown in Table 4.



The designated expert is requested to assign the key values with the
shortest encodings (1+0 and 1+1 encoding) to registrations that are
likely to enjoy wide use and can benefit from short encodings.

Each entry needs to provide a map key value (CBOR integer, int,
-18446744073709551616..18446744073709551615), a brief description of
the semantics, and a specification reference. Note that negative
integers indicate an elective key, while unsigned integers indicate a
key that either provides a base time or is critical. For the
unsigned integers as keys, the choice of base time or critical needs
to be indicated in the brief semantics description. (Elective map
keys may be explicitly marked as such in the description, e.g., to
distinguish them from critical keys.)

The initial contents are shown in Table 4.



Expand Down
Loading

0 comments on commit dc1d4d7

Please sign in to comment.