[Git][NTPsec/ntpsec][master] 4 commits: Documentation fixes.

Eric S. Raymond gitlab at mg.gitlab.com
Tue Aug 9 15:17:05 UTC 2016


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


Commits:
a461bbae by Matt Selsky at 2016-08-09T11:16:47-04:00
Documentation fixes.

- - - - -
99488903 by Matt Selsky at 2016-08-09T11:16:47-04:00
Fix some remaining references to palisade.

- - - - -
6e7783fe by Matt Selsky at 2016-08-09T11:16:47-04:00
Fix asciidoc link syntax.

- - - - -
89d6ade1 by Matt Selsky at 2016-08-09T11:16:47-04:00
Fix asciidoc markup

_+foo+_ produces a literal "+foo+" in italics, instead of some sort of
monospace/italics combination.  Remove the monospace since it's not working.

- - - - -


9 changed files:

- docs/debug.txt
- docs/driver_trimble.txt
- docs/includes/misc-options.txt
- docs/includes/mon-commands.txt
- docs/includes/ntpfrob-body.txt
- docs/includes/ntpkeygen-body.txt
- docs/includes/ntpq-body.txt
- docs/miscopt.txt
- docs/ntp_conf.txt


Changes:

=====================================
docs/debug.txt
=====================================
--- a/docs/debug.txt
+++ b/docs/debug.txt
@@ -133,7 +133,7 @@ select threshold, the server is considered invalid.
 
 Sometimes the time distribution of errors can be revealing. It's a
 good idea to look occasionally at the plots produced by
-link:ntpviz.html{ntpviz}].
+link:ntpviz.html[{ntpviz}].
 
 == Large Frequency Errors ==
 


=====================================
docs/driver_trimble.txt
=====================================
--- a/docs/driver_trimble.txt
+++ b/docs/driver_trimble.txt
@@ -192,7 +192,7 @@ configuration).
 7.  The driver reports the link:#TrackingStatus[tracking status of the
 receiver]. Make sure it is tracking several satellites.
 8.  Remove the +flag2+ option and restart the daemon in debug mode to observe
-palisade_receive events.
+trimble_receive events.
 9.  If event polling fails, verify the link:#Pinouts[connections] and
 that the host hardware supports RTS control.
 
@@ -258,7 +258,7 @@ link:#refid[+refid string+]::
 == Configuration Example ==
 
 ----------------------------------------------------------------------------
-refclock palisade
+refclock trimble
 ----------------------------------------------------------------------------
 
 == DEFINEs ==
@@ -270,7 +270,7 @@ systems.
 [width="50%",cols="<34%,<33%,<33%",options="header"]
 |===============================================================================
 | *Label*    | Definition                                      |Default Value
-| DEVICE     | The serial port device to be used by the driver | /dev/palisade__u__
+| DEVICE     | The serial port device to be used by the driver | /dev/trimble__u__
 | PRECISION  | Accuracy of time transfer                       | 1 microsecond
 |CURRENT_UTC | Valid GPS - UTC offset                          | 13
 |SPEED232    | Host RS-232 baud rate                           | B9600


=====================================
docs/includes/misc-options.txt
=====================================
--- a/docs/includes/misc-options.txt
+++ b/docs/includes/misc-options.txt
@@ -80,7 +80,7 @@ and that file system links, symbolic or otherwise, should be avoided.
   whether input is dropped without processing. The first parameter
   determines the action for addresses which match the second parameter.
   That parameter specifies a class of addresses, or a specific interface
-  name, or an address. In the address case, _+prefixlen+_ determines how
+  name, or an address. In the address case, _prefixlen_ determines how
   many bits must match for this rule to apply. +ignore+ prevents opening
   matching addresses, +drop+ causes +{ntpd}+ to open the address and drop
   all received packets without examination. Multiple +interface+
@@ -181,7 +181,7 @@ and so on is suppressed.
     entries or kilobytes. The default is 4 kilobytes.
 
 +nonvolatile+ 'threshold'::
-  Specify the _+threshold+_ in seconds to write the frequency file, with
+  Specify the _threshold_ in seconds to write the frequency file, with
   default of 1e-7 (0.1 PPM). The frequency file is inspected each hour.
   If the difference between the current frequency and the last value
   written exceeds the threshold, the file is written and the +threshold+


=====================================
docs/includes/mon-commands.txt
=====================================
--- a/docs/includes/mon-commands.txt
+++ b/docs/includes/mon-commands.txt
@@ -38,7 +38,7 @@ well. See information specific to each clock for further details.
 |+49213+        |MJD     |date
 |+525.624+      |s       |time past midnight
 |+SPECTRACOM(4)+|IP      |reference clock type and unit
-|_+message+_    |text    |log message
+|_message_      |text    |log message
 |===============================================
 +
 The first two fields show the date (Modified Julian Day) and time
@@ -81,7 +81,7 @@ time constant.
     Record significant peer and system events. Each significant
     event appends one line to the +protostats+ file set:
 +
-+49213 525.624 128.4.1.1 963a 8a+ _+message+_
++49213 525.624 128.4.1.1 963a 8a+ _message_
 +
 [width="100%",cols="<34%,<33%,<33%"]
 |====================================
@@ -91,10 +91,10 @@ time constant.
 |+128.4.1.1+|IP        |source address (+0.0.0.0+ for system)
 |+963a+     |code      |status word
 |+8a+       |code      |event message code
-|_+message+_|text      |event message
+|_message_  |text      |event message
 |====================================
 +
-The event message code and _+message+_ field are described on the
+The event message code and _message_ field are described on the
 "Event Messages and Status Words" page.
 
   +peerstats+;;
@@ -254,7 +254,7 @@ The remaining fields show the values used since the last report.
 |+10.0.3.5+   |IP       |server address
 |+1+          |#        |event count
 |+0.000014592+|s        |total time
-|_+message+_  |text     |code path description (see source)
+|_message_    |text     |code path description (see source)
 |====================================
 
   +statsdir+ _directory_path_;;


=====================================
docs/includes/ntpfrob-body.txt
=====================================
--- a/docs/includes/ntpfrob-body.txt
+++ b/docs/includes/ntpfrob-body.txt
@@ -69,7 +69,7 @@ enough to have a fully POSIX.1-2001-conformant Unix.
 
 === Clock bump ===
 
-Sometimes it is diagnostically interesting to peturb your clock in
+Sometimes it is diagnostically interesting to perturb your clock in
 order to watch how {ntpd} responds and makes corrections. This
 option does that.
 


=====================================
docs/includes/ntpkeygen-body.txt
=====================================
--- a/docs/includes/ntpkeygen-body.txt
+++ b/docs/includes/ntpkeygen-body.txt
@@ -365,15 +365,15 @@ and the program exits with a suitable error message.
 [[crypto]]
 == Cryptographic Data Files ==
 
-File and link names are in the form _+ntpkey_key_name.fstamp+_, where
-_+key+_ is the key or parameter type, _+name+_ is the host or group name and
-_+fstamp+_ is the filestamp (NTP seconds) when the file was created). By
-convention, _+key+_ names in generated file names include both upper and
-lower case characters, while _+key+_ names in generated link names
+File and link names are in the form _ntpkey_key_name.fstamp_, where
+_key_ is the key or parameter type, _name_ is the host or group name and
+_fstamp_ is the filestamp (NTP seconds) when the file was created). By
+convention, _key_ names in generated file names include both upper and
+lower case characters, while _key_ names in generated link names
 include only lower case characters. The filestamp is not used in
 generated link names.
 
-The _+key+_ name is a string defining the cryptographic key type. Key
+The _key_ name is a string defining the cryptographic key type. Key
 types include public/private keys +host+ and +sign+, certificate +cert+
 and several challenge/response key types. By convention, client files
 used for challenges have a +par+ subtype, as in the IFF challenge


=====================================
docs/includes/ntpq-body.txt
=====================================
--- a/docs/includes/ntpq-body.txt
+++ b/docs/includes/ntpq-body.txt
@@ -105,7 +105,7 @@ following.
   +{ntpq}+. A +?+ followed by a command keyword will print function and
   usage information about the command.
 
-+addvars+ _+name+_ [ = value] [...]; +rmvars+ _+name+_ [...]; +clearvars+::
++addvars+ _name_ [ = value] [...]; +rmvars+ _name_ [...]; +clearvars+::
   The arguments to this command consist of a list of items of the form
   +name = value+, where the += value+ is ignored, and can be omitted in
   read requests. +{ntpq}+ maintains an internal list in which data to be
@@ -284,7 +284,7 @@ ind assid status conf reach auth condition last_event cnt
   and +resall=+'hexmask' filter entries containing none or less than all,
   respectively, of the bits in 'hexmask', which must begin with +0x+.
 +
-The _+sortorder+_ defaults to +lstint+ and may be any of +addr+,
+The _sortorder_ defaults to +lstint+ and may be any of +addr+,
 +count+, +avgint+, +lstint+, or any of those preceded by a minus sign
 (hyphen) to reverse the sort order. The output columns are:
 +


=====================================
docs/miscopt.txt
=====================================
--- a/docs/miscopt.txt
+++ b/docs/miscopt.txt
@@ -33,8 +33,8 @@ include::includes/misc-options.txt[]
   discovery schemes. The options are as follows:
   +beacon+ 'beacon';;
     The manycast server sends packets at intervals of 64 s if less than
-    +maxclock+ servers are available. Otherwise, it sends packets at the
-    _+beacon+_ interval in seconds. The default is 3600 s. See the
+    _maxclock_ servers are available. Otherwise, it sends packets at the
+    _beacon_ interval in seconds. The default is 3600 s. See the
     link:discover.html[Automatic Server Discovery] page for further
     details.
   +ceiling+ 'ceiling';;


=====================================
docs/ntp_conf.txt
=====================================
--- a/docs/ntp_conf.txt
+++ b/docs/ntp_conf.txt
@@ -132,20 +132,20 @@ default token.
   +create_priority_queue+ function with the +get_fifo_order+ function
   as its argument.
 +void destroy_queue(queue *my_queue)+::
-  This function deletes _+my_queue+_ and frees up all the memory
+  This function deletes _my_queue_ and frees up all the memory
   allocated to it an its elements.
 +int empty(queue *my_queue)+::
-  This function checks to see if _+my_queue+_ is empty. Returns +true+
-  if _+my_queue+_ does not have any elements, else it returns false.
+  This function checks to see if _my_queue_ is empty. Returns +true+
+  if _my_queue_ does not have any elements, else it returns +false+.
 +queue *enqueue(queue *my_queue, void *my_node)+::
-  This function adds an element, _+my_node+_, to a queue, _+my_queue+_.
-  _+my_node+_ must be allocated on the heap using the +get_node+
+  This function adds an element, _my_node_, to a queue, _my_queue_.
+  _my_node_ must be allocated on the heap using the +get_node+
   function instead of +malloc+.
 +void *dequeue(queue *my_queue)+::
   This function returns the element at the front of the queue. This
-  element will be element with the highest priority.
+  element will be ithe element with the highest priority.
 +int get_no_of_elements(queue *my_queue)+::
-  This function returns the number of elements in _+my_queue+_.
+  This function returns the number of elements in _my_queue_.
 +void append_queue(queue *q1, queue *q2)+::
   This function adds all the elements of +q2+ to +q1+. The queue +q2+ is
   destroyed in the process.



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/compare/eb20d61d59b738b85f3f7d6dc6dba955c1f75fe0...89d6ade147b81e69fd7e599fc9f94bdc081efa73
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20160809/508fda46/attachment.html>


More information about the vc mailing list