Skip to content

Commit

Permalink
Fix formatting and errors in README and RELEASE_NOTES
Browse files Browse the repository at this point in the history
  • Loading branch information
beevik committed Jul 22, 2023
1 parent 24ace0e commit 03caaa1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ include:
authenticate the server's response.
* `Extensions`: Extensions may be added to modify NTP queries before they are
transmitted and to process NTP responses after they arrive.
* `Dial`: A custom network connection "dialer" function used to override the
* `Dialer`: A custom network connection "dialer" function used to override the
default UDP dialer function.


Expand Down
40 changes: 27 additions & 13 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Release v1.2.0
Extensions are able to (1) modify NTP messages before being sent to
the server, and (2) process NTP messages after they arrive from the
server. This feature has been added in preparation for NTS support.
* Added support for RFC 8905 symmetric key authentication.
* Added support for RFC 5905 symmetric key authentication.
* Allowed server address to be specified as a "host:port" pair.
* Brought package into further compliance with IETF draft on client data
minimization.
Expand Down Expand Up @@ -101,24 +101,38 @@ Release v0.1.1
Release v0.1.0
==============

This is the initial release of the `ntp` package. Currently it supports the following features:
This is the initial release of the `ntp` package. Currently it supports the
following features:
* `Time()` to query the current time according to a remote NTP server.
* `Query()` to query multiple pieces of time-related information from a remote NTP server.
* `QueryWithOptions()`, which is like `Query()` but with the ability to override default query options.
* `Query()` to query multiple pieces of time-related information from a remote
NTP server.
* `QueryWithOptions()`, which is like `Query()` but with the ability to
override default query options.

Time-related information returned by the `Query` functions includes:
* `Time`: the time the server transmitted its response, according to the server's clock.
* `ClockOffset`: the estimated offset of the client's clock relative to the server's clock. You may apply this offset to any local system clock reading once the query is complete.
* `RTT`: an estimate of the round-trip-time delay between the client and the server.
* `Time`: the time the server transmitted its response, according to the
server's clock.
* `ClockOffset`: the estimated offset of the client's clock relative to the
server's clock. You may apply this offset to any local system clock reading
once the query is complete.
* `RTT`: an estimate of the round-trip-time delay between the client and the
server.
* `Precision`: the precision of the server's clock reading.
* `Stratum`: the "stratum" level of the server, where 1 indicates a server directly connected to a reference clock, and values greater than 1 indicating the number of hops from the reference clock.
* `Stratum`: the "stratum" level of the server, where 1 indicates a server
directly connected to a reference clock, and values greater than 1
indicating the number of hops from the reference clock.
* `ReferenceID`: A unique identifier for the NTP server that was contacted.
* `ReferenceTime`: The time at which the server last updated its local clock setting.
* `ReferenceTime`: The time at which the server last updated its local clock
setting.
* `RootDelay`: The server's round-trip delay to the reference clock.
* `RootDispersion`: The server's total dispersion to the referenced clock.
* `RootDistance`: An estimate of the root synchronization distance.
* `Leap`: The leap second indicator.
* `MinError`: A lower bound on the clock error between the client and the server.
* `Poll`: the maximum polling interval between successive messages on the server.

The `Response` structure returned by the `Query` functions also contains a `Response.Validate()` function that returns an error if any of the fields returned by the server are invalid.
* `MinError`: A lower bound on the clock error between the client and the
server.
* `Poll`: the maximum polling interval between successive messages on the
server.

The `Response` structure returned by the `Query` functions also contains a
`Response.Validate()` function that returns an error if any of the fields
returned by the server are invalid.

0 comments on commit 03caaa1

Please sign in to comment.