[Git][NTPsec/ntpsec][master] Expand some addres type notations that are never documented.

[Eric S. Raymond]

Eric S. Raymond pushed to branch master at NTPsec / ntpsec


Commits:
34a33d33 by Eric S. Raymond at 2016-06-21T07:05:03-04:00
Expand some addres type notations that are never documented.

"type s address" = server address
"type r address" = refclock address
"type l address" = local address
"type b address" = broadcast address
"type m address" = multicast address

Cleans up Gitlab issue #80.

- - - - -


3 changed files:

- docs/confopt.txt
- docs/includes/assoc-commands.txt
- docs/includes/assoc-options.txt


Changes:

=====================================
docs/confopt.txt
=====================================
--- a/docs/confopt.txt
+++ b/docs/confopt.txt
@@ -35,7 +35,7 @@ Management] page are determined by the command keyword and the DNS name
 or IP address. Addresses are classed by type as (s) a remote server or
 peer (IPv4 class A, B and C or IPv6), (b) the IPv4 broadcast address of
 a local interface, (m) a multicast address (IPv4 class D or IPv6), or
-(r) a reference clock address (127.127.x.x). For type m addresses the
+(r) a reference clock address (127.127.x.x). For multicast addresses the
 IANA has assigned the multicast group address IPv4 224.0.1.1 and IPv6
 ff05::101 (site local) exclusively to NTP, but other nonconflicting
 addresses can be used.


=====================================
docs/includes/assoc-commands.txt
=====================================
--- a/docs/includes/assoc-commands.txt
+++ b/docs/includes/assoc-commands.txt
@@ -18,29 +18,29 @@ link-local IPV6 address with an interface specified in
   name or an IP address in dotted-quad notation.
 
 +pool+::
-  For type s addresses, this command mobilizes a persistent client mode
-  association with a number of remote servers. In this mode the local
-  clock can synchronized to the remote server, but the remote server can
-  never be synchronized to the local clock.
+  For server addresses, this command mobilizes a persistent client
+  mode association with a number of remote servers. In this mode the
+  local clock can synchronized to the remote server, but the remote
+  server can never be synchronized to the local clock.
 
 +server+::
-  For type s and r addresses, this command mobilizes a persistent client
+  For server and refclock addresses, this command mobilizes a persistent client
   mode association with the specified remote server or local radio
   clock. In this mode the local clock can synchronized to the remote
   server, but the remote server can never be synchronized to the local
-  clock. This command should _not_ be used for type b or m addresses.
+  clock. This command should _not_ be used for broadcast or multicast addresses.
 
 +peer+::
-  For type s addresses (only), this command mobilizes a persistent
+  For server addresses (only), this command mobilizes a persistent
   symmetric-active mode association with the specified remote peer. In
   this mode the local clock can be synchronized to the remote peer or
   the remote peer can be synchronized to the local clock. This is useful
   in a network of servers where, depending on various failure scenarios,
   either the local or remote peer may be the better source of time. This
-  command should NOT be used for type b, m or r addresses.
+  command should NOT be used for broadcast, multicast, or refclock addresses.
 
 +broadcast+::
-  For type b and m addresses (only), this command mobilizes a persistent
+  For broadcast and multicast addresses (only), this command mobilizes a persistent
   broadcast mode association. Multiple commands can be used to specify
   multiple local broadcast interfaces (subnets) and/or multiple
   multicast groups. Note that local broadcast messages go only to the
@@ -57,7 +57,7 @@ link-local IPV6 address with an interface specified in
   _broadcastclient_ or _multicastclient_ commands below.
 
 +manycastclient+::
-  For type m addresses (only), this command mobilizes a manycast client
+  For multicast addresses (only), this command mobilizes a manycast client
   mode association for the multicast address specified. In this case a
   specific address must be supplied which matches the address used on
   the _manycastserver_ command for the designated manycast servers. The


=====================================
docs/includes/assoc-options.txt
=====================================
--- a/docs/includes/assoc-options.txt
+++ b/docs/includes/assoc-options.txt
@@ -38,7 +38,7 @@
 +mode+ 'option'::
   Pass the +option+ to a reference clock driver, where +option+ is an
   integer in the range from 0 to 255, inclusive. This option is valid
-  only with type r addresses.
+  only with refclock addresses.
 
 +noselect+::
   Marks the server as unused, except for display purposes. The server is



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/34a33d3305f2228e8433069e14575d297603936d
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160621/b86f10e2/attachment.html>