[Git][NTPsec/ntpsec][master] Update docs to fix typos and bad asciidoc markup

Sun Dec 24 23:54:57 UTC 2017

Matt Selsky pushed to branch master at NTPsec / ntpsec


Commits:
8c068d56 by Matt Selsky at 2017-12-24T18:37:51-05:00
Update docs to fix typos and bad asciidoc markup

- - - - -


9 changed files:

- devel/TODO
- docs/authentic.txt
- docs/driver_jjy.txt
- docs/driver_oncore.txt
- docs/includes/misc-options.txt
- docs/includes/mon-commands.txt
- docs/includes/ntp-conf-body.txt
- docs/ntpsec.txt
- docs/quick.txt


Changes:

=====================================
devel/TODO
=====================================

--- a/devel/TODO
+++ b/devel/TODO
@@ -13,7 +13,7 @@
 [quote, Gary Miller]
 __________
 ntpd takes way, way, way longer to converge than chronyd.  Which is
-why on the fly reconfiguation in ntpd is SO important.  Last thing you
+why on the fly reconfiguration in ntpd is SO important.  Last thing you
 ever want to do is restart ntpd.
 
 Right now, after 10 mins, ntpd has 2,000 times the jitter as chronyd had
@@ -121,7 +121,7 @@ Pivot cleanup:
   of seconds in l_fp.  We can clean up a lot of code if l_fp is
   only used for offsets except when used in packets.  That requires
   pushing the pivot logic down close to the packet processing.
-  
+
   There may be interactions with ntpq.
 
 Recvbuff cleanup:


=====================================
docs/authentic.txt
=====================================
--- a/docs/authentic.txt
+++ b/docs/authentic.txt
@@ -178,7 +178,7 @@ various authentication schemes.
 By default, the client sends non-authenticated packets and the server
 responds with non-authenticated packets. If the client sends
 authenticated packets, the server responds with authenticated packets if
-correct, or a crypto-NAK packet if not. The +notrust +flag, described on the
+correct, or a crypto-NAK packet if not. The +notrust+ flag, described on the
 link:authopt.html[Access Control Options] page, can be used to disable
 access to all but correctly authenticated clients.
 


=====================================
docs/driver_jjy.txt
=====================================
--- a/docs/driver_jjy.txt
+++ b/docs/driver_jjy.txt
@@ -373,7 +373,7 @@ filegen clockstats file clockstats type day enable
 
 +unit+ 'number'::
   The driver unit number, defaulting to 0. Used as a distinguishing
-  suffix in the driver device name. 
+  suffix in the driver device name.
 +time1+ 'time'::
   Specifies the time offset calibration factor, in seconds and fraction,
   with default 0.0.


=====================================
docs/driver_oncore.txt
=====================================
--- a/docs/driver_oncore.txt
+++ b/docs/driver_oncore.txt
@@ -119,14 +119,14 @@ There is a driver specific configuration file +ntp.oncore+ (or
 than one Oncore receiver _unit_) that contains information on the startup mode,
 the location of the GPS receiver, an offset of the PPS signal from zero,
 and the cable delay. The offset shifts the PPS signal to avoid interrupt
-pileups +on' the second, and adjusts the timestamp accordingly. See the
+pileups `on' the second, and adjusts the timestamp accordingly. See the
 driver source for information on this file. The default with no file is:
 no delay, no offset, and a site survey is done to get the location of
 the gps receiver.
 
 The following three options can be set in the driver specific
 configuration file only if the driver is using the PPSAPI. The edge of
-the PPS signal that is +on-time' can be set with the keywords
+the PPS signal that is `on-time' can be set with the keywords
 [ASSERT/CLEAR] and the word HARDPPS will cause the PPS signal to control
 the kernel PLL.
 


=====================================
docs/includes/misc-options.txt
=====================================
--- a/docs/includes/misc-options.txt
+++ b/docs/includes/misc-options.txt
@@ -126,7 +126,7 @@ logconfig =syncstatus +sysevents
 +
 This would just list the synchronizations state of
 {ntpdman} and the major system events. For a simple reference
-server, the following minimum message configuration could be useful:_
+server, the following minimum message configuration could be useful:
 +
 ----------------------------
 logconfig =syncall +clockall
@@ -146,7 +146,7 @@ and so on is suppressed.
   Controls size limits of the monitoring facility Most Recently Used
   (MRU) list of client addresses, which is also
   used by the rate control facility.
-  +maxdepth+ 'count';;         
+  +maxdepth+ 'count';;
   +maxmem+ 'kilobytes';;
     Equivalent upper limits on the size of the MRU list, in terms of
     entries or kilobytes. The actual limit will be up to +incalloc+
@@ -176,12 +176,12 @@ and so on is suppressed.
     . If the age of the oldest slot is more than +minage+, the oldest
     slot is recycled (default 64 seconds).
     . Otherwise, no slot is available.
-  +initalloc+ 'count';;         
+  +initalloc+ 'count';;
   +initmem+ 'kilobytes';;
     Initial memory allocation at the time the monitoring facility is
     first enabled, in terms of entries or kilobytes. The default is 4
     kilobytes.
-  +incalloc+ 'count';;         
+  +incalloc+ 'count';;
   +incmem+ 'kilobytes';;
     Size of additional memory allocations when growing the MRU list, in
     entries or kilobytes. The default is 4 kilobytes.
@@ -290,7 +290,7 @@ The variables operate as follows:
     Ignored for backward compatibility.
   +stacksize+ _4kPages_;;
     Specifies the maximum size of the process stack on systems with the
-    mlockall()_function. Defaults to 50 4k pages.
+    +mlockall()+ function. Defaults to 50 4k pages.
   +filenum+ _filedescriptors_;;
     Specifies the maximum number of file descriptors ntpd may have open
     at once. Defaults to the system default.


=====================================
docs/includes/mon-commands.txt
=====================================
--- a/docs/includes/mon-commands.txt
+++ b/docs/includes/mon-commands.txt
@@ -336,10 +336,10 @@ Note that this command can be sent from the
         This number is taken to be the number of seconds the server is
         running at the start of the corresponding 24-hour period.
 
-   _link_ | _nolink_::
+   +link+ | +nolink+::
       It is convenient to be able to access the current element of a
       file generation set by a fixed name. This feature is enabled by
-      specifying _link_ and disabled using _nolink_. If link is
+      specifying +link+ and disabled using +nolink+. If link is
       specified, a hard link from the current file set element to a file
       without suffix is created. When there is already a file with this
       name and the number of links of this file is one, it is renamed


=====================================
docs/includes/ntp-conf-body.txt
=====================================
--- a/docs/includes/ntp-conf-body.txt
+++ b/docs/includes/ntp-conf-body.txt
@@ -24,9 +24,9 @@ lines. Arguments may be host names, host addresses written in numeric,
 dotted-quad form, integers, floating point numbers (when specifying
 times in seconds) and text strings.
 
-Configuration files may have inclusion lines.  The syntax is "include"
+Configuration files may have inclusion lines.  The syntax is +include+
 followed by whitespace followed by a file or directory name.  The
-configuation is evaluated as though the text of the file - or all
+configuration is evaluated as though the text of the file - or all
 files of the directory with the extension ".ntpd" - were textually
 spliced in at the point of the include. Relative paths will work, even
 when the -c option changes the config directory root.
@@ -65,9 +65,9 @@ Only those options applicable to each command are listed below. Use of
 options not listed may not be caught as an error, but may result in
 some weird and even destructive behavior.
 
-In contexts where a host name is expected, a `-4`or `--ipv4`
+In contexts where a host name is expected, a `-4` or `--ipv4`
 qualifier preceding the host name forces DNS resolution to the IPv4
-namespace, while a `-6` or `--ipv6' qualifier forces DNS resolution to
+namespace, while a `-6` or `--ipv6` qualifier forces DNS resolution to
 the IPv6 namespace.
 
 include::../includes/assoc-commands.txt[]
@@ -223,7 +223,7 @@ include::../includes/misc-options.txt[]
 
 `/etc/ntp.conf`::
   the default name of the configuration file
-_ntp.keys_::
+`ntp.keys`::
   private MD5 keys
 
 One of the following exit values will be returned:
@@ -247,4 +247,3 @@ David L. Mills, _Network Time Protocol (Version 4)_, RFC 5905
 
 The syntax checking is not picky; some combinations of ridiculous and
 even hilarious options and modes may not be detected.
-


=====================================
docs/ntpsec.txt
=====================================
--- a/docs/ntpsec.txt
+++ b/docs/ntpsec.txt
@@ -225,7 +225,7 @@ codebase has been outright removed, with less than 5% new code added.
   each refclock page.  One major feature of the new syntax is that
   refclock drivers are referred to by names, not numbers.
 
-* The unpeer command now takes a type-unit specofication when
+* The unpeer command now takes a type-unit specification when
   unpeering a clock.
 
 * For the generic (parse) driver only: Using the new refclock syntax,
@@ -238,7 +238,7 @@ codebase has been outright removed, with less than 5% new code added.
 * In server entries, its now possible to specify a time offset to be
   applied to incoming timestamps (analogues to the fudge on certain
   refclocks). This may be useful for client systems communicating
-  over ADSL lines, which have large but relatively fixed asymmetic delays.
+  over ADSL lines, which have large but relatively fixed asymmetric delays.
 
 * The _restrict_ statement can now take an address range in CIDR
   notation rather than as an address/mask pair.


=====================================
docs/quick.txt
=====================================
--- a/docs/quick.txt
+++ b/docs/quick.txt
@@ -75,7 +75,7 @@ driftfile /var/lib/ntp/ntp.drift
 
 This sets up a drift file, which is used to store a measurement of
 the drift frequency of your computer's clock crystal between runs
-of +ntpd. The drift is used to converge on correct time more quickly
+of +ntpd+. The drift is used to converge on correct time more quickly
 after startup.
 
 You might see something more like this:
@@ -129,7 +129,7 @@ server 3.ubuntu.pool.ntp.org
 
 Multiple declarations of individual pool servers are not the best you can
 do; they're a workaround for a historical bug in NTP Classic.  It's
-better to say 
+better to say
 
 ------------------------------------------------------------------
 pool ubuntu.pool.ntp.org
@@ -163,7 +163,7 @@ servers are located where packet-transit times to you are short and
 there is little random variation in them.  Because the NTP pool is
 worldwide, asking for a random assignment from it may give you a
 timeserver on the other side of the world.  Thus, the pool is divided
-into subsections.  To improve your service, pick a pool section near 
+into subsections.  To improve your service, pick a pool section near
 you on the network.
 
 Unfortunately, "near you on the network" is often difficult to map



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/8c068d56f69c38d889300b402d1f9bf8f38bb0cb

---
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/8c068d56f69c38d889300b402d1f9bf8f38bb0cb
You're receiving this email because of your account on gitlab.com.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20171224/dd641e71/attachment.html>
