[Git][NTPsec/ntpsec][master] 7 commits: Fix asciidoc formatting
Eric S. Raymond
gitlab at mg.gitlab.com
Sun Jan 24 12:03:53 UTC 2016
Eric S. Raymond pushed to branch master at NTPsec / ntpsec
Commits:
f616a4af by Sanjeev Gupta at 2016-01-24T03:40:41+08:00
Fix asciidoc formatting
- - - - -
2af60d1e by Sanjeev Gupta at 2016-01-24T03:54:04+08:00
Document for IPv6
- - - - -
c3ca0ed9 by Sanjeev Gupta at 2016-01-24T04:06:30+08:00
Add reference to pool command
- - - - -
fed43edf by Sanjeev Gupta at 2016-01-24T04:16:15+08:00
Correct typo for DCF77
- - - - -
08502c4c by Sanjeev Gupta at 2016-01-24T04:21:34+08:00
Update deprecation for Driver 38
hopf GPS/DCF77 6021/komp for Serial Line
- - - - -
0f546944 by Sanjeev Gupta at 2016-01-24T04:38:47+08:00
Update driver table to add RefID
and general cleanup.
- - - - -
340f8fb3 by Sanjeev Gupta at 2016-01-24T04:59:00+08:00
Move links in "Related Links" to a level 3 header
This is not complete, I am manually proofreading each page
- - - - -
15 changed files:
- NEWS
- docs/access.txt
- docs/assoc.txt
- docs/includes/accopt.txt
- docs/includes/audio.txt
- docs/includes/authopt.txt
- docs/includes/clockopt.txt
- docs/includes/config.txt
- docs/includes/confopt.txt
- docs/includes/hand.txt
- docs/includes/install.txt
- docs/includes/ntpfrob-body.txt
- docs/includes/refclock.txt
- docs/parsenew.txt
- docs/refclock.txt
Changes:
=====================================
NEWS
=====================================
--- a/NEWS
+++ b/NEWS
@@ -121,7 +121,7 @@ the 0.9.0 beta release.
* [Bug 2625] Deprecate flag1 in local refclock. Hal Murray, Harlan Stenn.
* [Bug 2778] Implement "apeers" ntpq command to include associd.
* [Bug 2823] ntpsweep with recursive peers option doesn't work. H.Stenn.
-* [Bug 2836] DFC77 patches from Frank Kardel to make decoding more
+* [Bug 2836] DCF77 patches from Frank Kardel to make decoding more
robust, and require 2 consecutive timestamps to be consistent.
* [Bug 2845] Harden memory allocation in ntpd; implement and
use 'eallocarray(...)' where appropriate.
=====================================
docs/access.txt
=====================================
--- a/docs/access.txt
+++ b/docs/access.txt
@@ -31,12 +31,13 @@ format:
+restrict address [mask mask] [flag][...]+
-The +address+ argument expressed in dotted-quad form is the address of a
+The +address+ argument expressed in dotted-quad (for IPv4) or
+:-delimited (for IPv6) form is the address of a
host or network. Alternatively, the +address+ argument can be a valid
host DNS name. The +mask+ argument expressed in IPv4 or IPv6 numeric
address form defaults to all mask bits on, meaning that the +address+ is
treated as the address of an individual host. A default entry (address
-0.0.0.0, mask 0.0.0.0 for IPv4 and address :: mask :: for IPv6) is
+0.0.0.0, mask 0.0.0.0 for IPv4; and address :: mask :: for IPv6) is
always the first entry in the list. +restrict default+, with no mask
option, modifies both IPv4 and IPv6 default entries. +restrict source+
configures a template restriction automatically added at runtime for
=====================================
docs/assoc.txt
=====================================
--- a/docs/assoc.txt
+++ b/docs/assoc.txt
@@ -69,10 +69,11 @@ client (mode 3) request to the specified server and expects a server
described as a "pull" operation, in that the host pulls the time and
related values from the server.
-A host is configured in client mode using the +server+ (sic) command and
-specifying the server DNS name or IPv4 or IPv6 address; the server
-requires no prior configuration. The +iburst+ option described later on
-this page is recommended for clients, as this speeds up initial
+A host is configured in client mode using the +server+ (sic)
+or +pool+ command and specifying the server DNS name or IPv4 or
+IPv6 address; the server requires no prior configuration (but
+see link:access.html[Access Control]). The +iburst+ option described
+later on this page is recommended for clients, as this speeds up initial
synchronization from several minutes to several seconds. The +burst+
option described later on this page can be useful to reduce jitter on
very noisy dial-up or ISDN network links.
=====================================
docs/includes/accopt.txt
=====================================
--- a/docs/includes/accopt.txt
+++ b/docs/includes/accopt.txt
@@ -1,4 +1,4 @@
-== Access Control Commands and Options ==
+=== Access Control Commands and Options ===
* link:accopt.html#discard[discard - specify headway parameters]
* link:accopt.html#restrict[restrict - specify access restrictions]
* link:comdex.html[Command Index]
=====================================
docs/includes/audio.txt
=====================================
--- a/docs/includes/audio.txt
+++ b/docs/includes/audio.txt
@@ -1,4 +1,4 @@
-== Reference Clock Audio Drivers ==
+=== Reference Clock Audio Drivers ===
* link:driver6.html[IRIG Audio Decoder]
* link:driver7.html[Radio CHU Audio Demodulator/Decoder]
* link:audio.html[Reference Clock Audio Drivers]
=====================================
docs/includes/authopt.txt
=====================================
--- a/docs/includes/authopt.txt
+++ b/docs/includes/authopt.txt
@@ -1,4 +1,4 @@
-== Authentication Commands and Options ==
+=== Authentication Commands and Options ===
* link:authopt.html#automax[automax - specify Autokey regeneration interval]
* link:authopt.html#controlkey[controlkey - specify control key ID]
* link:authopt.html#crypto[crypto - configure Autokey parameters]
=====================================
docs/includes/clockopt.txt
=====================================
--- a/docs/includes/clockopt.txt
+++ b/docs/includes/clockopt.txt
@@ -1,4 +1,4 @@
-== Reference Clock Commands and Options ==
+=== Reference Clock Commands and Options ===
* link:clockopt.html#fudge[fudge - specify fudge parameters]
* link:clockopt.html#server[server - specify reference clock server]
* link:comdex.html[Command Index]
=====================================
docs/includes/config.txt
=====================================
--- a/docs/includes/config.txt
+++ b/docs/includes/config.txt
@@ -1,4 +1,4 @@
-== Client and Server Configuration ==
+=== Client and Server Configuration ===
* link:assoc.html[Association Management]
* link:discover.html[Automatic Server Discovery Schemes]
* link:sitemap.html[Site Map]
=====================================
docs/includes/confopt.txt
=====================================
--- a/docs/includes/confopt.txt
+++ b/docs/includes/confopt.txt
@@ -1,4 +1,4 @@
-== Server Commands and Options ==
+=== Server Commands and Options ===
* link:confopt.html#server[server - configure client association]
* link:confopt.html#peer[peer - configure symmetric peer association]
* link:confopt.html#broadcast[broadcast - configure broadcast server association]
=====================================
docs/includes/hand.txt
=====================================
--- a/docs/includes/hand.txt
+++ b/docs/includes/hand.txt
@@ -1,4 +1,4 @@
-== Handbook Pages ==
+=== Handbook Pages ===
* link:comdex.html[Command Index]
* link:access.html[Access Control Support]
* link:assoc.html[Association Management]
=====================================
docs/includes/install.txt
=====================================
--- a/docs/includes/install.txt
+++ b/docs/includes/install.txt
@@ -1,4 +1,4 @@
-== Build and Install ==
+=== Build and Install ===
* link:build.html[Building and Installing the Distribution]
* link:rdebug.html[Debugging Reference Clock Drivers]
* link:quick.html[Quick Start]
=====================================
docs/includes/ntpfrob-body.txt
=====================================
--- a/docs/includes/ntpfrob-body.txt
+++ b/docs/includes/ntpfrob-body.txt
@@ -49,7 +49,7 @@ maintainers.
Normally this tool reports in an eyeball-friendly unstructured text
format. With the -j option (where applicable) it reports JSON records.
-Note that the -j option should be given before any mode option.
+Note that the -j option should be given before any mode option.
The reporting formats of this tool should be considered unstable;
they may change as diagnostics are added or improved. JSON
@@ -59,7 +59,7 @@ reports will be kept forward-compatible through changes.
The -A function reads your clock's tick rate in microseconds. The -a
function sets it. Both rely on the adjtimex(2) system call. This
-mode finishes by tereporting the tick value and (if available) the
+mode finishes by reporting the tick value and (if available) the
tick adjustment value.
The -j option is applicable to this mode.
@@ -72,15 +72,15 @@ enough to have a fully POSIX.1-2001-conformant Unix.
The -c option can be used to determine the timing jitter due to the
operating system in a gettimeofday() call. For most systems the
dominant contribution to the jitter budget is the period of the
-hardware interrupt, usually in the range 10 us-1 ms. For those systems
-with microsecond counters the jitter is dominated only by the
-operating system.
+hardware interrupt, usually in the range between 10 us and 1 ms. For
+those systems with microsecond counters the jitter is dominated
+only by the operating system.
The -j option is applicable to this mode. With the -r option, write
the raw unsorted clock samples to standard output for post-analysis.
-All but the last -j or -r option before the -c mode flag is ignored
+All but the last -j or -r option before the -c mode flag is ignored.
-=== Pulse-per-second check ==
+=== Pulse-per-second check ===
The -p option shows whether the PPS-API (RFC 2783 kernel
PPS interface) finds PPS on a specified device.
=====================================
docs/includes/refclock.txt
=====================================
--- a/docs/includes/refclock.txt
+++ b/docs/includes/refclock.txt
@@ -1,4 +1,4 @@
-== Reference Clock Support ==
+=== Reference Clock Support ===
* link:extern.html[External Clock Discipline and the Local Clock Driver]
* link:howto.html[How to Write a Reference Clock Driver]
* link:howto.html[How to build new PARSE clocks]
=====================================
docs/parsenew.txt
=====================================
--- a/docs/parsenew.txt
+++ b/docs/parsenew.txt
@@ -14,7 +14,7 @@ What to do:
Make a conversion module (libparse/clk_*.c)
-1. What ist the time code format ?
+1. What is the time code format ?
* find year, month, day, hour, minute, second, status (synchronised or
not), possibly time zone information (you need to give the offset to
UTC) You will have to convert the data from a string into a struct
@@ -68,13 +68,13 @@ These are feature flags denoting items that are supported by the clock:
----------------------------------------------------------------------------
+
-If the utctime field is non zero this value will be take as time code
+If the utctime field is non-zero this value will be take as time code
value. This allows for conversion routines that already have the utc
time value. The utctime field gives the seconds since Jan 1st 1970,
0:00:00. The useconds field gives the respective usec value. The fields
for date and time (down to second resolution) will be ignored.
+
-Conversion is done in the cvt_* routine in parse/clk_*.c files. look in
+Conversion is done in the cvt_* routine in parse/clk_*.c files. Look in
them for examples. The basic structure is:
+
-----------------------------------------------------
@@ -127,8 +127,9 @@ The above should have given you some hints on how to build a clk_*.c
file with the time code conversion. See the examples and pick a clock
closest to yours and tweak the code to match your clock.
+
-In order to make your clk_*.c file usable a reference to the clockformat
+In order to make your clk_*.c file usable, a reference to the clockformat
structure must be put into parse_conf.c.
+
2. TTY setup and initialization/configuration will be done in
ntpd/refclock_parse.c.
* Find out the exact tty settings for your clock (baud rate, parity,
@@ -207,8 +208,8 @@ clocks for example)
};
-------------------------------------------------------------------------------------
-Well, this is very sketchy, i know. But I hope it helps a little bit.
-The best way is to look which clock comes closest to your and tweak that
+Well, this is very sketchy, I know. But I hope it helps a little bit.
+The best way is to look which clock comes closest to yours and tweak that
code.
Two sorts of clocks are used with parse. Clocks that automatically send
@@ -217,7 +218,7 @@ because they send the data all the time. The second sort are the clocks
that need a command sent to them in order to reply with a time code
(like the Trimble clock).
-For questions: mailto:%20kardel%20AT%20acm.org[kardel at acm.org].
+For questions: mailto:kardel at acm.org[kardel at acm.org].
Please include an exact description on how your clock works.
(initialization, TTY modes, strings to be sent to it, responses received
=====================================
docs/refclock.txt
=====================================
--- a/docs/refclock.txt
+++ b/docs/refclock.txt
@@ -152,8 +152,8 @@ driver relative to an association designated the prefer peer.
== List of Reference Clock Drivers ==
Following is a list showing the type and title of each driver currently
-implemented. The compile-time identifier for each is shown in
-parentheses. Click on a selected type for specific description and
+implemented. The default compile-time identifier for each is shown in
+under +RefID+. Click on a selected type for specific description and
configuration documentation, including the clock address, reference ID,
driver ID, device name and serial line speed. For those drivers without
specific documentation, please contact the author listed in the
@@ -170,36 +170,36 @@ a closed-source driver to run. This filtered out the
Datum/Bancomm/Symmetricom bc600-series GPS/IRIG Receiver.
[options="header"]
-[cols="10%,5%,85%",options="header"]
+[cols="10%,5%,5%,80%",options="header"]
|====================================================================
-| Number | Flags | Driver
-| link:driver1.html[Type 1] | D | Undisciplined Local Clock
-| link:driver4.html[Type 4] | - | Generic Spectracom Receivers
-| link:driver5.html[Type 5] | D | TrueTime GPS/GOES Receivers
-| link:driver6.html[Type 6] | D | IRIG Audio Decoder
-| link:driver7.html[Type 7] | D | Radio CHU Audio Demodulator/Decoder
-| link:driver8.html[Type 8] | T | Generic Reference Driver (Parse)
-| link:driver9.html[Type 9] | D | Magnavox MX4200 GPS Receiver
-| link:driver10.html[Type 10] | D | Austron 2200A/2201A GPS Receivers
-| link:driver11.html[Type 11] | D | Arbiter 1088A/B GPS Receiver
-| link:driver18.html[Type 18] | - | NIST/USNO/PTB Modem Time Services
-| link:driver20.html[Type 20] | T | Generic NMEA GPS Receiver
-| link:driver22.html[Type 22] | T | PPS Clock Discipline
-| link:driver26.html[Type 26] | T | Hewlett Packard 58503A GPS Receiver
-| link:driver27.html[Type 27] | D | Arcron MSF Receiver
-| link:driver28.html[Type 28] | T | Shared Memory Driver
-| link:driver29.html[Type 29] | TM | Trimble Navigation Palisade GPS
-| link:driver30.html[Type 30] | - | Motorola UT Oncore GPS
-| link:driver31.html[Type 31] | D | Rockwell Jupiter GPS
-| link:driver33.html[Type 33] | D | Dumb Clock
-| link:driver35.html[Type 35] | D | Conrad Parallel Port Radio Clock
-| link:driver38.html[Type 38] | - | hopf GPS/DCF77 6021/komp for Serial Line
-| link:driver39.html[Type 39] | - | hopf GPS/DCF77 6039 for PCI-Bus
-| link:driver40.html[Type 40] | T | JJY Receivers
-| link:driver42.html[Type 42] | - | Zyfer GPStarplus Receiver
-| link:driver44.html[Type 44] | - | NeoClock4X - DCF77 / TDF serial line
-| link:driver45.html[Type 45] | - | Spectracom TSYNC PCI
-| link:driver46.html[Type 46] | T | GPSD NG client protocol
+| Number | Flags |RefID| Driver
+| link:driver1.html[Type 1] | D |LOCL | Undisciplined Local Clock
+| link:driver4.html[Type 4] | - |+SPECTRACOM+| Generic Spectracom Receivers
+| link:driver5.html[Type 5] | D |TRUE | TrueTime GPS/GOES Receivers
+| link:driver6.html[Type 6] | D |IRIG | IRIG Audio Decoder
+| link:driver7.html[Type 7] | D |+CHU+| Radio CHU Audio Demodulator/Decoder
+| link:driver8.html[Type 8] | TR |DCFx | Generic Reference Driver (Parse)
+| link:driver9.html[Type 9] | D |GPS | Magnavox MX4200 GPS Receiver
+| link:driver10.html[Type 10] | D |GPS | Austron 2200A/2201A GPS Receivers
+| link:driver11.html[Type 11] | D |GPS | Arbiter 1088A/B GPS Receiver
+| link:driver18.html[Type 18] | R |NIST | NIST/USNO/PTB Modem Time Services
+| link:driver20.html[Type 20] | T |GPS | Generic NMEA GPS Receiver
+| link:driver22.html[Type 22] | T |PPS | PPS Clock Discipline
+| link:driver26.html[Type 26] | T |GPS | Hewlett Packard 58503A GPS Receiver
+| link:driver27.html[Type 27] | DR |MSF | Arcron MSF Receiver
+| link:driver28.html[Type 28] | T |SHM | Shared Memory Driver
+| link:driver29.html[Type 29] | TM |GPS | Trimble Navigation Palisade GPS
+| link:driver30.html[Type 30] | - |GPS | Motorola UT Oncore GPS
+| link:driver31.html[Type 31] | D |GPS | Rockwell Jupiter GPS
+| link:driver33.html[Type 33] | D |DUMB | Dumb Clock
+| link:driver35.html[Type 35] | D |PCF | Conrad Parallel Port Radio Clock
+| link:driver38.html[Type 38] | D |hopf | hopf GPS/DCF77 6021/komp for Serial Line
+| link:driver39.html[Type 39] | - |hopf | hopf GPS/DCF77 6039 for PCI-Bus
+| link:driver40.html[Type 40] | T |JJY | JJY Receivers
+| link:driver42.html[Type 42] | - |GPS | Zyfer GPStarplus Receiver
+| link:driver44.html[Type 44] | - |neol | NeoClock4X - DCF77 / TDF serial line
+| link:driver45.html[Type 45] | R |GPS | Spectracom TSYNC PCI
+| link:driver46.html[Type 46] | T |GPSD | GPSD NG client protocol
|====================================================================
The flags field should be interpreted as follows:
@@ -210,11 +210,12 @@ The flags field should be interpreted as follows:
| D | Deprecated. May be removed in a future release
| T | Regularly tested by an active maintainer (some devices/modes)
| M | The driver supports multiple devices or major modes
+| R | Multiple Reference IDs supported, please check the driver page
|====================================================================
Driver numbers 2, 3, 12, 13, 14, 15, 16, 17, 19, 21, 23, 24, 25, 32, 34,
36, 37, 41, and 43 (all unused numbers below 46) are reserved. Some of
-these were used by refclock types (now obsolete) in older NTP versions
+these were used by refclock types (now obsolete) in older NTP versions.
'''''
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/compare/1072e976a964101b7e7ffb41c461a9d0c2a60f21...340f8fb38a8ec5d72b3d628fea44b7862a904c2a
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160124/93913ac9/attachment.html>
More information about the vc
mailing list