Commit 75ea3d2c authored by Eric S. Raymond's avatar Eric S. Raymond

Use .adoc rather than .txt for asciidoc follows.

This conforms to the convention now established by Fitllab and Gitub.
It allows these to be browsed through those web interfaces in rendered form.
parent 92129133
Pipeline #43116031 passed with stages
in 3 minutes and 42 seconds
......@@ -45,7 +45,7 @@ packages depending on whether your base Python version is 2 or 3.
Python 2.x, x >= 6, or Python 3.x, x >= 3::
Required to build, and for various scripts such as ntpviz (but see
the guidance for packagers in devel/packaging.txt). Our Python code
the guidance for packagers in devel/packaging.adoc). Our Python code
has been written polyglot to also run with production versions of
Python 3. Note that you will need both the ordinary Python
installation and Python dev tools, if your OS makes such a
......@@ -176,7 +176,7 @@ installation prefix other than `/usr/local' by giving waf the
option `--prefix=PATH'.
You should read the section "Path problems with the test tools" in
devel/testing.txt before setting a non-default prefix.
devel/testing.adoc before setting a non-default prefix.
There is a separate `--destdir' option that changes the root of the
entire installation hierarchy, prepending all paths. It defaults to `/'.
......@@ -191,7 +191,7 @@ at configure time and saved until install time.
== Qualification testing ==
Details on how to qualify NTPsec if you've never used it before
are at devel/testing.txt.
are at devel/testing.adoc.
== Strict compatibility mode ==
......
......@@ -3,7 +3,7 @@
For historic news from NTP Classic, see devel/HISTORIC-NEWS in the
distribution.
Not all news features are described here; see docs/ntpsec.txt in the
Not all news features are described here; see docs/ntpsec.adoc in the
distribution.
Much of the traditional function of a news file is now better addressed
......
......@@ -13,7 +13,7 @@ ChangeLog::
dot.emacs::
C-mode indentation rules for code "Just the way Dave likes it".
hacking.txt::
hacking.adoc::
Notes to folks who want to hack on the code.
ifdex-ignores::
......@@ -22,10 +22,10 @@ ifdex-ignores::
make-tarball::
The script for building a release tarball.
ntpv5.txt::
ntpv5.adoc::
Design notes towards NTPv5.
pre-release.txt::
pre-release.adoc::
A collection of ideas about testing before a release.
release::
......@@ -34,16 +34,16 @@ release::
TODO::
List of items the NTPsec developers are working on.
testing.txt::
testing.adoc::
How to qualify NTPsec for production use.
tour.txt:
tour.adoc:
A tour of the NTP internals.
HISTORIC-NEWS::
NTP Classic news file up to 4.2.8p3 (May 2015).
y2k.txt::
y2k.adoc::
Notes on Y2K conformance.
release.nix::
......
......@@ -155,13 +155,13 @@ __________
* A conformant SNMP subagent in Python - see RFC 5907.
* In the docs subdirectory, include/command.txt is an HTML passthrough
* In the docs subdirectory, include/command.adoc is an HTML passthrough
in a not entirely successful attempt to emulate the look of the
Mills HTML documentation this directory was made from. It should be
cleaned up or replaced. Requires HTML and CSS skills; intern must
be willing to learn asciidoc.
* Similarly, includes/footer.txt is a tabular hack made to resemble
* Similarly, includes/footer.adoc is a tabular hack made to resemble
the old HTML and should be cleaned up. Requires HTML and CSS
skills; intern must be willing to learn asciidoc
......
......@@ -7,7 +7,7 @@ Annoying but necessary legalese:
forms and usages of the open-source community.
If you want to learn more about the code internals, consult the
../devel/tour.txt file. This document is about development practices
../devel/tour.adoc file. This document is about development practices
and project conventions.
You may also find the articles at https://blog.ntpsec.org/
......@@ -407,9 +407,9 @@ C was the minor. They also use release-candidate suffixes.
== Version string ==
We use the BUILD_EPOCH as described in packaging/packaging.txt for the
timestamp (converted to RFC 3339 format) part of the version string reported in
ntpd and other binaries.
We use the BUILD_EPOCH as described in packaging/packaging.adoc for
the timestamp (converted to RFC 3339 format) part of the version
string reported in ntpd and other binaries.
Release builds have version strings of the form:
......
......@@ -57,7 +57,7 @@ def tabulate(path):
# generated HTML, the file part of a stored anchor name needs to be
# the original path from the top of the include stack, not
# whatever inclusion we might be walking through now.
html = path[len(prefix):].replace(".txt", ".html")
html = path[len(prefix):].replace(".adoc", ".html")
m = boxanchor_re.search(line)
if m:
anchor = "link:" + html + "#" + m.group(1)
......@@ -78,7 +78,7 @@ if __name__ == '__main__':
for dirpath, dnames, fnames in os.walk(prefix):
for f in fnames:
fullpath = os.path.join(dirpath, f)
if fullpath.endswith(".txt") and "includes" not in fullpath:
if fullpath.endswith(".adoc") and "includes" not in fullpath:
tabulate(fullpath)
# print("References: %s" % references)
# print("Anchors: %s" % anchors)
......
......@@ -61,7 +61,7 @@ will override that panic and allow one big step.
We should verify that the cx_Freeze recipe for converting
our Python based utilities to non-Python works.
Details are in devel/packaging.txt
Details are in devel/packaging.adoc
We should test cold-start with no drift file.
......
......@@ -12,8 +12,8 @@ The skunk watches for intruders and sprays.
== Related Links ==
include::includes/hand.txt[]
include::includes/accopt.txt[]
include::includes/hand.adoc[]
include::includes/accopt.adoc[]
'''''
......@@ -94,4 +94,4 @@ otherwise unconfigured; no flags are associated with the default entry
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ The skunk watches for intruders and sprays.
== Related Links ==
include::includes/accopt.txt[]
include::includes/accopt.adoc[]
'''''
......@@ -21,8 +21,8 @@ include::includes/accopt.txt[]
Unless noted otherwise, further information about these commands is on
the link:access.html[Access Control Support] page.
include::includes/access-commands.txt[]
include::includes/access-commands.adoc[]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -13,7 +13,7 @@ Make sure who your friends are.
== Related Links ==
include::includes/hand.txt[]
include::includes/hand.adoc[]
== Table of Contents ==
......@@ -237,4 +237,4 @@ minimum poll interval for the association.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,8 +12,8 @@ Our resident cryptographer; now you see him, now you don't.
== Related Links ==
include::includes/hand.txt[]
include::includes/authopt.txt[]
include::includes/hand.adoc[]
include::includes/authopt.adoc[]
== Table of Contents ==
......@@ -216,4 +216,4 @@ It used key ids greater than 64K.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ Our resident cryptographer; now you see him, now you don't.
== Related Links ==
include::includes/authopt.txt[]
include::includes/authopt.adoc[]
'''''
......@@ -21,8 +21,8 @@ include::includes/authopt.txt[]
Unless noted otherwise, further information about these commands is on
the link:authentic.html[Authentication Support] page.
include::includes/auth-commands.txt[]
include::includes/auth-commands.adoc[]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -37,4 +37,4 @@ register on and use our bugtracker instance to report issues.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ For putting out compiler fires.
== Related Links ==
include::includes/install.txt[]
include::includes/install.adoc[]
== Table of Contents ==
......@@ -106,4 +106,4 @@ link:bugs.html[NTP Bug Reporting Procedures] page.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -170,4 +170,4 @@ SYNC - Ordinary clock discipline state::
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -10,8 +10,8 @@ Master Time Facility at the {millshome}lab.html[UDel Internet Research Laborator
== Related Links ==
include::includes/refclock.txt[]
include::includes/clockopt.txt[]
include::includes/refclock.adoc[]
include::includes/clockopt.adoc[]
'''''
......@@ -24,8 +24,8 @@ the link:refclock.html[Reference Clock Support] page.
[[options]]
== Commands and Options ==
include::includes/clock-options.txt[]
include::includes/clock-options.adoc[]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -71,4 +71,4 @@ smallest maximum error.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,13 +12,13 @@ The Mad Hatter says "Bring it on".
== Related Links ==
include::includes/accopt.txt[]
include::includes/authopt.txt[]
include::includes/confopt.txt[]
include::includes/monopt.txt[]
include::includes/clockopt.txt[]
include::includes/miscopt.txt[]
include::includes/accopt.adoc[]
include::includes/authopt.adoc[]
include::includes/confopt.adoc[]
include::includes/monopt.adoc[]
include::includes/clockopt.adoc[]
include::includes/miscopt.adoc[]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ The chicken is getting configuration advice.
== Related Links ==
include::includes/confopt.txt[]
include::includes/confopt.adoc[]
== Table of Contents ==
......@@ -58,12 +58,12 @@ compatible pool of public NTP servers, which are probably what you
want to define associations with unless you specifically know
otherwise.
include::includes/assoc-commands.txt[]
include::includes/assoc-commands.adoc[]
[[option]]
== Server Command Options ==
include::includes/assoc-options.txt[]
include::includes/assoc-options.adoc[]
[[aux]]
== Auxiliary Commands ==
......@@ -71,8 +71,8 @@ include::includes/assoc-options.txt[]
Information on authentication for broadcast options can be found at
link:authopt.html[Authentication Options].
include::includes/assoc-auxcommands.txt[]
include::includes/assoc-auxcommands.adoc[]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -235,4 +235,4 @@ been removed:
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ We make house calls and bring our own bugs.
== More Help ==
include::includes/install.txt[]
include::includes/install.adoc[]
'''''
......@@ -277,4 +277,4 @@ at the project website.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -14,7 +14,7 @@ Caterpillar knows all the error codes, which is more than most of us do.
== Related Links ==
include::includes/install.txt[]
include::includes/install.adoc[]
== Table of Contents ==
......@@ -271,4 +271,4 @@ identifier field in +ntpq+ billboards. Following is the current list:
| +STEP+ | step time change
|==================================================================
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -199,4 +199,4 @@ link:miscopt.html#tos[+tos+] command.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ Make sure who your friends are.
== Related Links ==
include::includes/hand.txt[]
include::includes/hand.adoc[]
== Table of Contents ==
......@@ -117,4 +117,4 @@ use multiple servers that the DNS resolves to, refreshing as required.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -167,4 +167,4 @@ updated within the current GPS era.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -500,4 +500,4 @@ link:refclock.html[Reference Clock Drivers]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -284,4 +284,4 @@ clock skew from UTC at boot time.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -12,7 +12,7 @@ You need a little magic.
== Related Links ==
include::includes/misc.txt[]
include::includes/misc.adoc[]
== Table of Contents ==
......@@ -252,4 +252,4 @@ buffer and update the system clock.
image:pic/pogo1a.gif[]
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -123,4 +123,4 @@ refclock hpgps
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -409,4 +409,4 @@ See the examples in the Description section.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -86,4 +86,4 @@ David L. Mills <mills@udel.edu>
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -188,4 +188,4 @@ link:refclock.html[Reference Clock Drivers]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -99,4 +99,4 @@ mailto:neoclock4@linum.com[neoclock4x@linum.com].
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -281,4 +281,4 @@ perverse failure modes (especially at startup time). The only
remedy is not to use ancient GPS hardware.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -148,4 +148,4 @@ timekeeping under FreeBSD].
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -186,4 +186,4 @@ David L. Mills <mills@udel.edu>
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -230,4 +230,4 @@ link:refclock.html[Reference Clock Drivers]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -145,4 +145,4 @@ David L. Mills <mills@udel.edu>
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -442,4 +442,4 @@ mailto:fernandoph@iar.unlp.edu.ar[*Fernando P. Hauscarriaga*] +
Instituto Argentino de Radioastronomia +
http://www.iar.unlp.edu.ar +
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -124,4 +124,4 @@ link:refclock.html[Reference Clock Drivers]
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -65,4 +65,4 @@ refclock zyfer
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -93,4 +93,4 @@ zero.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -99,4 +99,4 @@ specifically designed to operate at this rate.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -231,4 +231,4 @@ from the clock).
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
......@@ -50,4 +50,4 @@ area between the limb lines is heavily populated.
'''''
include::includes/footer.txt[]
include::includes/footer.adoc[]
// Association options - included twice.
//
// Note, some of these options are described with special refclock
// semantics in includes/clock-options.txt.
// semantics in includes/clock-options.adoc.
+bias+::
Add the command argument, a floating-point value in seconds, to the
......
......@@ -68,19 +68,19 @@ qualifier preceding the host name forces DNS resolution to the IPv4
namespace, while a `-6` or `--ipv6` qualifier forces DNS resolution to
the IPv6 namespace.
include::../includes/assoc-commands.txt[]
include::../includes/assoc-commands.adoc[]
=== Association Options ===
include::../includes/assoc-options.txt[]
include::../includes/assoc-options.adoc[]
=== Association Auxiliary Commands ===
include::../includes/assoc-auxcommands.txt[]
include::../includes/assoc-auxcommands.adoc[]
== Authentication Commands ==
include::../includes/auth-commands.txt[]
include::../includes/auth-commands.adoc[]
[[monit]]
== Monitoring Support ==
......@@ -96,7 +96,7 @@ analysis.
=== Monitoring Commands ===
include::../includes/mon-commands.txt[]
include::../includes/mon-commands.adoc[]
== Access Control Support ==
......@@ -159,7 +159,7 @@ server operator cooperates.
== Access Control Commands ==
include::../includes/access-commands.txt[]
include::../includes/access-commands.adoc[]
== Automatic NTP Configuration Options ==
......@@ -172,7 +172,7 @@ Discovery" page (available as part of the HTML documentation).
// This is a subset of the tos options applicable to manycast.
// It omits the more general tinkering options. If you change this,
// be very sure to keep docs/miscopt.txt synchronized.
// be very sure to keep docs/miscopt.adoc synchronized.
`tos` [`ceiling` _ceiling_ | `floor` _floor_ | `minclock` _minclock_ | `minsane` _minsane_]::
This command affects the clock selection and clustering algorithms. It
......@@ -210,11 +210,11 @@ documentation provided in `/usr/share/doc/ntp`).
== Reference Clock Commands
include::../includes/clock-options.txt[]
include::../includes/clock-options.adoc[]
== Miscellaneous Options ==
include::../includes/misc-options.txt[]
include::../includes/misc-options.adoc[]
== FILES ==
......
......@@ -37,11 +37,11 @@ If no hostname is specified on the command line, localhost is monitored.
Here's a breakdown of the peers display in the top window:
include::peerfmt.txt[]
include::peerfmt.adoc[]
And the MRU list in the bottom window:
include::mrufmt.txt[]
include::mrufmt.adoc[]
== Commands ==
......@@ -114,6 +114,6 @@ protocol extension not yet present in those versions.
Even with this extension, monitoring a sufficiently high-traffic