[Git][NTPsec/ntpsec][master] Make sure options to configure use proper asciidoc markdown

Matt Selsky gitlab at mg.gitlab.com
Sun Dec 31 06:42:56 UTC 2017 

Matt Selsky pushed to branch master at NTPsec / ntpsec


Commits:
3f4dcd30 by Matt Selsky at 2017-12-31T06:29:06+00:00
Make sure options to configure use proper asciidoc markdown

- - - - -


7 changed files:

- docs/driver_generic.txt
- docs/includes/mon-commands.txt
- docs/includes/ntpd-body.txt
- docs/includes/ntpq-body.txt
- docs/includes/ntpviz-body.txt
- docs/leapsmear.txt
- docs/ntpsec.txt


Changes:

=====================================
docs/driver_generic.txt
=====================================
--- a/docs/driver_generic.txt
+++ b/docs/driver_generic.txt
@@ -90,7 +90,7 @@ and any number of these clocks may be operational at any one time.
 Note: Under NTPsec, you _must_ use the new configuration syntax
 (refclock generic subtype N) to declare generic clocks, rather than
 the old-style syntax with a magic address, unless the software has
-been built with the --enable-classic-mode option in which case *only*
+been built with the +--enable-classic-mode+ option in which case *only*
 the old-style syntax will work.
 
 A note on the implementations:


=====================================
docs/includes/mon-commands.txt
=====================================
--- a/docs/includes/mon-commands.txt
+++ b/docs/includes/mon-commands.txt
@@ -226,7 +226,7 @@ The remaining fields show the values used since the last report.
 
   +timingstats+;;
    (Only available when the daemon is compiled with process time
-   debugging support (--enable-debug-timing - costs performance). Record
+   debugging support (+--enable-debug-timing+ - costs performance). Record
    processing time statistics for various selected code paths.
 +
 +53876 36.920 10.0.3.5 1 0.000014592 input processing delay+


=====================================
docs/includes/ntpd-body.txt
=====================================
--- a/docs/includes/ntpd-body.txt
+++ b/docs/includes/ntpd-body.txt
@@ -547,10 +547,10 @@ On most systems, you can send SIGHUP to +ntpd+ with
   # sigkill -HUP ntpd
 -----
 
-If built with debugging enabled (waf configured without --disable-debug)
+If built with debugging enabled (waf configured without +--disable-debug+)
 SIGUSR1 will increase the debug level by 1 and
 SIGUSR2 will decrease it by 1.  This may be helpful if you are
-running without -n, either just to see the logging on your screen
+running without +-n+, either just to see the logging on your screen
 or with gdb.
 
 [[bugs]]


=====================================
docs/includes/ntpq-body.txt
=====================================
--- a/docs/includes/ntpq-body.txt
+++ b/docs/includes/ntpq-body.txt
@@ -551,7 +551,7 @@ by 'name', a shortname for the driver type.
 
 In older versions, no count of control packets was listed under sysstats.
 
-The -O (--old-rv) option of legacy versions has been retired.
+The +-O+ (+--old-rv+) option of legacy versions has been retired.
 
 == Known Limitations ==
 


=====================================
docs/includes/ntpviz-body.txt
=====================================
--- a/docs/includes/ntpviz-body.txt
+++ b/docs/includes/ntpviz-body.txt
@@ -107,12 +107,12 @@ The following plots are available:
 
 --all-peer-jitters::
    Report all peer jitters.  This is a different option name from
-   --peer-jitters only because of a limitation in the Python
+   +--peer-jitters+ only because of a limitation in the Python
    standard library.
 
 --all-peer-offsets::
    Report all peer offsets.  This is a different option name from
-   --peer-offsets only because of a minor limitation in the Python
+   +--peer-offsets+ only because of a minor limitation in the Python
    standard library.
 
 --local-error::


=====================================
docs/leapsmear.txt
=====================================
--- a/docs/leapsmear.txt
+++ b/docs/leapsmear.txt
@@ -184,8 +184,8 @@ configured on time servers providing dedicated clients with time, if all
 those clients can accept smeared time.
 
 * Leap Second Smearing is NOT configured by default.  The only way to get
-this behavior is to invoke the ./configure script from the NTP source code
-package with the --enable-leap-smear parameter before the executables are
+this behavior is to invoke the +./waf configure+ script from the NTP source code
+package with the +--enable-leap-smear+ parameter before the executables are
 built.
 
 * Even if ntpd has been compiled to enable leap smearing support, leap


=====================================
docs/ntpsec.txt
=====================================
--- a/docs/ntpsec.txt
+++ b/docs/ntpsec.txt
@@ -51,7 +51,7 @@ few will be user-visible.
 Normally NTPsec is a drop-in replacement for legacy versions. We have
 tried to hold incompatible changes to a minimum, but there are a
 few.  Some can be reverted by building the software in strict
-compatibility mode with --enable-classic-mode (note that this is
+compatibility mode with +--enable-classic-mode+ (note that this is
 a build-time switch, not a run-time one).
 
 * The +sntp+ program has been renamed +ntpdig+ in order to make
@@ -60,26 +60,26 @@ a build-time switch, not a run-time one).
   is ntpwait, and +update-leap+ is now +ntpleapfetch+.
 
 * Log timestamps look a little different; they are now in ISO 8601 format.
-  Reverted in the --enable-classic-mode build.
+  Reverted in the +--enable-classic-mode+ build.
 
 * Clock identifiers in log files are normally the driver shortname
   followed by the unit number in parentheses, rather than the magic IP
   addresses formerly used.  This change affects the peerstats, rawstats,
-  and clockstats files.  Reverted in the --enable-classic-mode build.
+  and clockstats files.  Reverted in the +--enable-classic-mode+ build.
 
 * The -!m, -\>, and -< options of some Classic commands are not
   supported.  (The argument-parsing framework code that implemented
   them in Classic was overcomplicated and buggy and had to be removed.)
 
-* The shortname of --help options is now -h, not -?
+* The shortname of +--help+ options is now +-h+, not +-?+
 
 * If you had a refclock on a path of the form /dev/palisadeNNN, that
   link needs to change to /dev/trimbleNNN. Reverted in the
-  --enable-classic-mode build.
+  +--enable-classic-mode+ build.
 
 * If you had a refclock on a path of the form /dev/actsNNN, that
   link needs to change to /dev/modemNNN. Reverted in the
-  --enable-classic-mode build.
+  +--enable-classic-mode+ build.
 
 * An instance of +ntpq+ built from the NTPsec code
   querying a legacy NTP daemon will not automatically display
@@ -90,7 +90,7 @@ a build-time switch, not a run-time one).
 * The ttl-hop option for broadcast mode has been removed from the
   configuration grammar.  It was never actually implemented.
 
-* ntpq no longer has the -i/--interactive option, as there was no
+* ntpq no longer has the +-i+/+--interactive+ option, as there was no
   situation in which it was meaningful.
 
 * Interleave mode has been removed.  It was buggy and the root cause
@@ -131,8 +131,8 @@ codebase has been outright removed, with less than 5% new code added.
 
 * Various features related to runtime dumping of the configuration
   state have been removed for security reasons.  These include the
-  saveconfig command in ntpq, the --saveconfigquit option of ntpd, and
-  the implementation of related config declarations in ntp.conf.
+  +saveconfig+ command in +ntpq+, the +--saveconfigquit+ option of ntpd, and
+  the implementation of related config declarations in +ntp.conf+.
 
 * Likewise, the poorly-documented ntpdsim code has also been removed
   to gain a significant reduction in code complexity.
@@ -233,7 +233,7 @@ codebase has been outright removed, with less than 5% new code added.
   (numbers 0-3) to unlimited.  However, the old magic-address syntax
   will not work correctly - you _must_ use the new syntax to declare
   generic-driver refclocks.  If the software was compiled with the
-  --enable-classic-mode switch, the foregoing is reversed.
+  +--enable-classic-mode+ switch, the foregoing is reversed.
 
 * In server entries, its now possible to specify a time offset to be
   applied to incoming timestamps (analogues to the fudge on certain



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/3f4dcd305694b018217cb1f55f96250703a68815

---
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/3f4dcd305694b018217cb1f55f96250703a68815
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/20171231/f6ac38ff/attachment.html>

More information about the vc mailing list